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.Module;
  33 import java.net.URL;
  34 import java.security.AccessControlContext;
  35 import java.util.Map;
  36 import java.util.concurrent.ConcurrentHashMap;
  37 import java.util.stream.Stream;
  38 
  39 import jdk.internal.module.ServicesCatalog;
  40 import sun.reflect.ConstantPool;
  41 import sun.reflect.annotation.AnnotationType;
  42 import sun.nio.ch.Interruptible;
  43 
  44 public interface JavaLangAccess {
  45     /** Return the constant pool for a class. */
  46     ConstantPool getConstantPool(Class<?> klass);
  47 
  48     /**
  49      * Compare-And-Swap the AnnotationType instance corresponding to this class.
  50      * (This method only applies to annotation types.)
  51      */
  52     boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType);
  53 
  54     /**
  55      * Get the AnnotationType instance corresponding to this class.
  56      * (This method only applies to annotation types.)
  57      */
  58     AnnotationType getAnnotationType(Class<?> klass);
  59 
  60     /**
  61      * Get the declared annotations for a given class, indexed by their types.
  62      */
  63     Map<Class<? extends Annotation>, Annotation> getDeclaredAnnotationMap(Class<?> klass);
  64 
  65     /**
  66      * Get the array of bytes that is the class-file representation
  67      * of this Class' annotations.
  68      */
  69     byte[] getRawClassAnnotations(Class<?> klass);
  70 
  71     /**
  72      * Get the array of bytes that is the class-file representation
  73      * of this Class' type annotations.
  74      */
  75     byte[] getRawClassTypeAnnotations(Class<?> klass);
  76 
  77     /**
  78      * Get the array of bytes that is the class-file representation
  79      * of this Executable's type annotations.
  80      */
  81     byte[] getRawExecutableTypeAnnotations(Executable executable);
  82 
  83     /**
  84      * Returns the elements of an enum class or null if the
  85      * Class object does not represent an enum type;
  86      * the result is uncloned, cached, and shared by all callers.
  87      */
  88     <E extends Enum<E>> E[] getEnumConstantsShared(Class<E> klass);
  89 
  90     /** Set thread's blocker field. */
  91     void blockedOn(Thread t, Interruptible b);
  92 
  93     /**
  94      * Registers a shutdown hook.
  95      *
  96      * It is expected that this method with registerShutdownInProgress=true
  97      * is only used to register DeleteOnExitHook since the first file
  98      * may be added to the delete on exit list by the application shutdown
  99      * hooks.
 100      *
 101      * @param slot  the slot in the shutdown hook array, whose element
 102      *              will be invoked in order during shutdown
 103      * @param registerShutdownInProgress true to allow the hook
 104      *        to be registered even if the shutdown is in progress.
 105      * @param hook  the hook to be registered
 106      *
 107      * @throws IllegalStateException if shutdown is in progress and
 108      *         the slot is not valid to register.
 109      */
 110     void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook);
 111 
 112     /**
 113      * Returns a new string backed by the provided character array. The
 114      * character array is not copied and must never be modified after the
 115      * String is created, in order to fulfill String's contract.
 116      *
 117      * @param chars the character array to back the string
 118      * @return a newly created string whose content is the character array
 119      */
 120     String newStringUnsafe(char[] chars);
 121 
 122     /**
 123      * Returns a new Thread with the given Runnable and an
 124      * inherited AccessControlContext.
 125      */
 126     Thread newThreadWithAcc(Runnable target, AccessControlContext acc);
 127 
 128     /**
 129      * Invokes the finalize method of the given object.
 130      */
 131     void invokeFinalize(Object o) throws Throwable;
 132 
 133     /**
 134      * Returns the boot Layer
 135      */
 136     Layer getBootLayer();
 137 
 138     /**
 139      * Returns the ServicesCatalog for the given class loader.
 140      */
 141     ServicesCatalog getServicesCatalog(ClassLoader cl);
 142 
 143     /**
 144      * Returns the ServicesCatalog for the given class loader, creating it
 145      * if doesn't already exist.
 146      */
 147     ServicesCatalog createOrGetServicesCatalog(ClassLoader cl);
 148 
 149     /**
 150      * Returns the ConcurrentHashMap used as a storage for ClassLoaderValue(s)
 151      * associated with the given class loader, creating it if it doesn't already exist.
 152      */
 153     ConcurrentHashMap<?, ?> createOrGetClassLoaderValueMap(ClassLoader cl);
 154 
 155     /**
 156      * Returns a class loaded by the bootstrap class loader.
 157      */
 158     Class<?> findBootstrapClassOrNull(ClassLoader cl, String name);
 159 
 160     /**
 161      * Returns a URL to a resource with the given name in a module that is
 162      * defined to the given class loader.
 163      */
 164     URL findResource(ClassLoader cl, String moduleName, String name) throws IOException;
 165 
 166     /**
 167      * Returns the Packages for the given class loader.
 168      */
 169     Stream<Package> packages(ClassLoader cl);
 170 
 171     /**
 172      * Define a Package of the given name and module by the given class loader.
 173      */
 174     Package definePackage(ClassLoader cl, String name, Module module);
 175 
 176     /**
 177      * Invokes Long.fastUUID
 178      */
 179     String fastUUID(long lsb, long msb);
 180 }