1 /*
  2  * Copyright (c) 1996, 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 java.lang.reflect;
 27 
 28 import java.util.Set;
 29 
 30 /**
 31  * Member is an interface that reflects identifying information about
 32  * a single member (a field or a method) or a constructor.
 33  *
 34  * @see java.lang.Class
 35  * @see Field
 36  * @see Method
 37  * @see Constructor
 38  *
 39  * @author Nakul Saraiya
 40  * @since 1.1
 41  */
 42 public interface Member {
 43 
 44     /**
 45      * Identifies the set of all public members of a class or interface,
 46      * including inherited members.
 47      */
 48     public static final int PUBLIC = 0;
 49 
 50     /**
 51      * Identifies the set of declared members of a class or interface.
 52      * Inherited members are not included.
 53      */
 54     public static final int DECLARED = 1;
 55 
 56     /**
 57      * Returns the Class object representing the class or interface
 58      * that declares the member or constructor represented by this Member.
 59      *
 60      * @return an object representing the declaring class of the
 61      * underlying member
 62      */
 63     public Class<?> getDeclaringClass();
 64 
 65     /**
 66      * Returns the simple name of the underlying member or constructor
 67      * represented by this Member.
 68      *
 69      * @return the simple name of the underlying member
 70      */
 71     public String getName();
 72 
 73     /**
 74      * Returns the Java language modifiers for the member or
 75      * constructor represented by this Member, as an integer.  The
 76      * Modifier class should be used to decode the modifiers in
 77      * the integer.
 78      *
 79      * @return the Java language modifiers for the underlying member
 80      * @see Modifier
 81      * @see #accessFlags()
 82      */
 83     public int getModifiers();
 84 
 85 
 86     /**
 87      * {@return an unmodifiable set of the {@linkplain AccessFlag
 88      * access flags} for this member, possibly empty}
 89      *
 90      * @implSpec
 91      * The default implementation returns an empty set.
 92      * @see #getModifiers()
 93      * @since 20
 94      */
 95     public default Set<AccessFlag> accessFlags() {
 96         return Set.of();
 97     }
 98 
 99     /**
100      * Returns {@code true} if this member was introduced by
101      * the compiler; returns {@code false} otherwise.
102      *
103      * @return true if and only if this member was introduced by
104      * the compiler.
105      * @jls 13.1 The Form of a Binary
106      * @since 1.5
107      */
108     public boolean isSynthetic();
109 }