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