1 /*
2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package jdk.internal.misc;
27
28 import java.io.IOException;
29 import java.lang.annotation.Annotation;
30 import java.lang.reflect.Executable;
31 import java.lang.reflect.Layer;
32 import java.lang.reflect.Method;
33 import java.lang.reflect.Module;
34 import java.net.URL;
35 import java.security.AccessControlContext;
36 import java.security.ProtectionDomain;
37 import java.util.Map;
38 import java.util.concurrent.ConcurrentHashMap;
39 import java.util.stream.Stream;
40
41 import jdk.internal.reflect.ConstantPool;
42 import sun.reflect.annotation.AnnotationType;
43 import sun.nio.ch.Interruptible;
44
45 public interface JavaLangAccess {
46
47 /**
48 * Returns a {@code Method} object that reflects the specified public
49 * member method of the given class. Returns {@code null} if the
50 * method is not defined.
51 */
52 Method getMethodOrNull(Class<?> klass, String name, Class<?>... parameterTypes);
53
54 /** Return the constant pool for a class. */
55 ConstantPool getConstantPool(Class<?> klass);
56
57 /**
58 * Compare-And-Swap the AnnotationType instance corresponding to this class.
59 * (This method only applies to annotation types.)
60 */
61 boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType);
62
63 /**
64 * Get the AnnotationType instance corresponding to this class.
65 * (This method only applies to annotation types.)
66 */
67 AnnotationType getAnnotationType(Class<?> klass);
68
69 /**
70 * Get the declared annotations for a given class, indexed by their types.
71 */
72 Map<Class<? extends Annotation>, Annotation> getDeclaredAnnotationMap(Class<?> klass);
73
74 /**
75 * Get the array of bytes that is the class-file representation
76 * of this Class' annotations.
77 */
78 byte[] getRawClassAnnotations(Class<?> klass);
79
80 /**
81 * Get the array of bytes that is the class-file representation
82 * of this Class' type annotations.
83 */
84 byte[] getRawClassTypeAnnotations(Class<?> klass);
85
86 /**
87 * Get the array of bytes that is the class-file representation
88 * of this Executable's type annotations.
89 */
90 byte[] getRawExecutableTypeAnnotations(Executable executable);
91
92 /**
93 * Returns the elements of an enum class or null if the
94 * Class object does not represent an enum type;
95 * the result is uncloned, cached, and shared by all callers.
96 */
97 <E extends Enum<E>> E[] getEnumConstantsShared(Class<E> klass);
98
99 /** Set thread's blocker field. */
100 void blockedOn(Thread t, Interruptible b);
101
102 /**
103 * Registers a shutdown hook.
104 *
105 * It is expected that this method with registerShutdownInProgress=true
106 * is only used to register DeleteOnExitHook since the first file
107 * may be added to the delete on exit list by the application shutdown
108 * hooks.
109 *
110 * @param slot the slot in the shutdown hook array, whose element
111 * will be invoked in order during shutdown
112 * @param registerShutdownInProgress true to allow the hook
113 * to be registered even if the shutdown is in progress.
114 * @param hook the hook to be registered
115 *
116 * @throws IllegalStateException if shutdown is in progress and
117 * the slot is not valid to register.
118 */
119 void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook);
120
121 /**
122 * Returns a new string backed by the provided character array. The
123 * character array is not copied and must never be modified after the
124 * String is created, in order to fulfill String's contract.
125 *
126 * @param chars the character array to back the string
127 * @return a newly created string whose content is the character array
128 */
129 String newStringUnsafe(char[] chars);
130
131 /**
132 * Returns a new Thread with the given Runnable and an
133 * inherited AccessControlContext.
134 */
135 Thread newThreadWithAcc(Runnable target, AccessControlContext acc);
136
137 /**
138 * Invokes the finalize method of the given object.
139 */
140 void invokeFinalize(Object o) throws Throwable;
141
142 /**
143 * Returns the boot Layer
144 */
145 Layer getBootLayer();
146
147 /**
148 * Returns the ConcurrentHashMap used as a storage for ClassLoaderValue(s)
149 * associated with the given class loader, creating it if it doesn't already exist.
150 */
151 ConcurrentHashMap<?, ?> createOrGetClassLoaderValueMap(ClassLoader cl);
152
153 /**
154 * Defines a class with the given name to a class loader.
155 */
156 Class<?> defineClass(ClassLoader cl, String name, byte[] b, ProtectionDomain pd, String source);
157
158 /**
159 * Returns a class loaded by the bootstrap class loader.
160 */
161 Class<?> findBootstrapClassOrNull(ClassLoader cl, String name);
162
163 /**
164 * Returns a URL to a resource with the given name in a module that is
165 * defined to the given class loader.
166 */
167 URL findResource(ClassLoader cl, String moduleName, String name) throws IOException;
168
169 /**
170 * Returns the Packages for the given class loader.
171 */
172 Stream<Package> packages(ClassLoader cl);
173
174 /**
175 * Define a Package of the given name and module by the given class loader.
176 */
177 Package definePackage(ClassLoader cl, String name, Module module);
178
179 /**
180 * Invokes Long.fastUUID
181 */
182 String fastUUID(long lsb, long msb);
183
184 /**
185 * Invalidate package access cache
186 */
187 void invalidatePackageAccessCache();
188 }