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