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 sun.misc;
  27 
  28 import java.lang.annotation.Annotation;
  29 import java.lang.reflect.Executable;
  30 import java.security.AccessControlContext;
  31 import java.util.Map;
  32 import java.util.function.Function;
  33 
  34 import sun.reflect.ConstantPool;
  35 import sun.reflect.annotation.AnnotationType;
  36 import sun.nio.ch.Interruptible;
  37 
  38 public interface JavaLangAccess {
  39     /** Return the constant pool for a class. */
  40     ConstantPool getConstantPool(Class<?> klass);
  41 
  42     /**
  43      * Compare-And-Swap the AnnotationType instance corresponding to this class.
  44      * (This method only applies to annotation types.)
  45      */
  46     boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType);
  47 
  48     /**
  49      * Get the AnnotationType instance corresponding to this class.
  50      * (This method only applies to annotation types.)
  51      */
  52     AnnotationType getAnnotationType(Class<?> klass);
  53 
  54     /**
  55      * Get the declared annotations for a given class, indexed by their types.
  56      */
  57     Map<Class<? extends Annotation>, Annotation> getDeclaredAnnotationMap(Class<?> klass);
  58 
  59     /**
  60      * Get the array of bytes that is the class-file representation
  61      * of this Class' annotations.
  62      */
  63     byte[] getRawClassAnnotations(Class<?> klass);
  64 
  65     /**
  66      * Get the array of bytes that is the class-file representation
  67      * of this Class' type annotations.
  68      */
  69     byte[] getRawClassTypeAnnotations(Class<?> klass);
  70 
  71     /**
  72      * Get the array of bytes that is the class-file representation
  73      * of this Executable's type annotations.
  74      */
  75     byte[] getRawExecutableTypeAnnotations(Executable executable);
  76 
  77     /**
  78      * Returns the elements of an enum class or null if the
  79      * Class object does not represent an enum type;
  80      * the result is uncloned, cached, and shared by all callers.
  81      */
  82     <E extends Enum<E>> E[] getEnumConstantsShared(Class<E> klass);
  83 
  84     /**
  85      * If given Class represents a generic class or interface, then the result of
  86      * applying given function to the Class object is returned, otherwise null.
  87      * The result is cached in per-Class map using identity of given key.
  88      */
  89     <D> D getGenericDerivative(Class<?> clazz, Object key,
  90                                Function<Class<?>, ? extends D> function);
  91 
  92     /** Set thread's blocker field. */
  93     void blockedOn(Thread t, Interruptible b);
  94 
  95     /**
  96      * Registers a shutdown hook.
  97      *
  98      * It is expected that this method with registerShutdownInProgress=true
  99      * is only used to register DeleteOnExitHook since the first file
 100      * may be added to the delete on exit list by the application shutdown
 101      * hooks.
 102      *
 103      * @params slot  the slot in the shutdown hook array, whose element
 104      *               will be invoked in order during shutdown
 105      * @params registerShutdownInProgress true to allow the hook
 106      *               to be registered even if the shutdown is in progress.
 107      * @params hook  the hook to be registered
 108      *
 109      * @throw IllegalStateException if shutdown is in progress and
 110      *          the slot is not valid to register.
 111      */
 112     void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook);
 113 
 114     /**
 115      * Returns the number of stack frames represented by the given throwable.
 116      */
 117     int getStackTraceDepth(Throwable t);
 118 
 119     /**
 120      * Returns the ith StackTraceElement for the given throwable.
 121      */
 122     StackTraceElement getStackTraceElement(Throwable t, int i);
 123 
 124     /**
 125      * Returns a new string backed by the provided character array. The
 126      * character array is not copied and must never be modified after the
 127      * String is created, in order to fulfill String's contract.
 128      *
 129      * @param chars the character array to back the string
 130      * @return a newly created string whose content is the character array
 131      */
 132     String newStringUnsafe(char[] chars);
 133 
 134     /**
 135      * Returns a new Thread with the given Runnable and an
 136      * inherited AccessControlContext.
 137      */
 138     Thread newThreadWithAcc(Runnable target, AccessControlContext acc);
 139 
 140     /**
 141      * Invokes the finalize method of the given object.
 142      */
 143     void invokeFinalize(Object o) throws Throwable;
 144 
 145     /**
 146      * Invokes Long.formatUnsignedLong(long val, int shift, char[] buf, int offset, int len)
 147      */
 148     void formatUnsignedLong(long val, int shift, char[] buf, int offset, int len);
 149 
 150     /**
 151      * Invokes Integer.formatUnsignedInt(long val, int shift, char[] buf, int offset, int len)
 152      */
 153     void formatUnsignedInt(int val, int shift, char[] buf, int offset, int len);
 154 }