1 /*
   2  * Copyright (c) 2009, 2014, 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.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package jdk.vm.ci.meta;
  24 
  25 import java.lang.annotation.*;
  26 import java.lang.reflect.*;
  27 
  28 /**
  29  * Represents a reference to a resolved Java field. Fields, like methods and types, are resolved
  30  * through {@link ConstantPool constant pools}.
  31  */
  32 public interface ResolvedJavaField extends JavaField, ModifiersProvider {
  33 
  34     /**
  35      * {@inheritDoc}
  36      * <p>
  37      * Only the {@linkplain Modifier#fieldModifiers() field flags} specified in the JVM
  38      * specification will be included in the returned mask.
  39      */
  40     int getModifiers();
  41 
  42     default boolean isFinal() {
  43         return ModifiersProvider.super.isFinalFlagSet();
  44     }
  45 
  46     /**
  47      * Determines if this field was injected by the VM. Such a field, for example, is not derived
  48      * from a class file.
  49      */
  50     boolean isInternal();
  51 
  52     /**
  53      * Determines if this field is a synthetic field as defined by the Java Language Specification.
  54      */
  55     boolean isSynthetic();
  56 
  57     /**
  58      * Returns the {@link ResolvedJavaType} object representing the class or interface that declares
  59      * this field.
  60      */
  61     ResolvedJavaType getDeclaringClass();
  62 
  63     /**
  64      * Returns all annotations of this field. If no annotations are present, an array of length 0 is
  65      * returned.
  66      */
  67     Annotation[] getAnnotations();
  68 
  69     /**
  70      * Returns the annotation for the specified type of this field, if such an annotation is
  71      * present.
  72      *
  73      * @param annotationClass the Class object corresponding to the annotation type
  74      * @return this element's annotation for the specified annotation type if present on this field,
  75      *         else {@code null}
  76      */
  77     <T extends Annotation> T getAnnotation(Class<T> annotationClass);
  78 
  79     /**
  80      * Returns an object representing the unique location identity of this resolved Java field.
  81      *
  82      * @return the location identity of the field
  83      */
  84     LocationIdentity getLocationIdentity();
  85 }