モジュール java.base
パッケージ java.lang.reflect

クラスParameter

java.lang.Object
java.lang.reflect.Parameter
すべての実装されたインタフェース:
AnnotatedElement
public final class Parameter extends Object implements AnnotatedElement
メソッド・パラメータに関する情報。 Parameterは、名前および修飾子を含む、メソッド・パラメータに関する情報を提供します。 また、パラメータの属性を取得する代替手段も提供します。
導入されたバージョン:
1.8

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    Set<AccessFlag>
    accessFlags()
    このオブジェクトによって表されるパラメータに対して、変更できない「アクセス・フラグ」のセットを返します(空の場合もあります)。
    boolean
    equals(Object obj)
    実行可能ファイルとインデックスに基づいて比較します。
    AnnotatedType
    getAnnotatedType()
    このParameterによって表される仮パラメータの型を指定する型の使用を表すAnnotatedTypeオブジェクトを返します。
    <T extends Annotation>
    T
    getAnnotation(Class<T> annotationClass)
    存在する場合は、この要素の指定された型の注釈を返し、そうでない場合はnullを返します。
    Annotation[]
    getAnnotations()
    この要素に存在する注釈を返します。
    <T extends Annotation>
    T[]
    getAnnotationsByType(Class<T> annotationClass)
    この要素に関連付けられている注釈を返します。
    <T extends Annotation>
    T
    getDeclaredAnnotation(Class<T> annotationClass)
    直接存在する場合は、この要素の指定された型の注釈を返し、そうでない場合はnullを返します。
    Annotation[]
    getDeclaredAnnotations()
    この要素に直接存在する注釈を返します。
    <T extends Annotation>
    T[]
    getDeclaredAnnotationsByType(Class<T> annotationClass)
    直接存在するか間接的に存在する場合は、この要素の指定された型の注釈を返します。
    Executable
    getDeclaringExecutable()
    このパラメータを宣言するExecutableを返します。
    int
    getModifiers()
    このオブジェクトによって表されるパラメータのJava言語modifiersを返します。
    String
    getName()
    パラメータの名前を返します。
    Type
    getParameterizedType()
    Parameterオブジェクトで表されるパラメータのパラメータ化された型を識別するTypeオブジェクトを返します。
    Class<?>
    getType()
    このParameterオブジェクトによって表されるパラメータの宣言された型を識別するClassオブジェクトを返します。
    int
    hashCode()
    実行可能要素のハッシュ・コードおよびインデックスに基づくハッシュ・コードを返します。
    boolean
    isImplicit()
    このパラメータがソース・コードで暗黙的に宣言されている場合はtrueを返し、そうでない場合はfalseを返します。
    boolean
    isNamePresent()
    パラメータがクラス・ファイルに従った名前を持つ場合はtrueを返し、そうでない場合はfalseを返します。
    boolean
    isSynthetic()
    このパラメータがソース・コードで暗黙的にも明示的にも宣言されていない場合はtrueを返し、そうでない場合はfalseを返します。
    boolean
    isVarArgs()
    このパラメータが可変引数リストを表す場合はtrueを返し、そうでない場合はfalseを返します。
    String
    toString()
    このパラメータを記述した文字列を返します。

    クラスjava.lang.Objectで宣言されたメソッド

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    インタフェースjava.lang.reflect.AnnotatedElementで宣言されたメソッド

    isAnnotationPresent

  • メソッドの詳細

    • equals

      public boolean equals(Object obj)
      実行可能ファイルとインデックスに基づいて比較します。
      オーバーライド:
      equals、クラスObject
      パラメータ:
      obj - 比較するオブジェクト
      戻り値:
      これが引数と等しいかどうか
      関連項目:

    • hashCode

      public int hashCode()
      実行可能要素のハッシュ・コードおよびインデックスに基づくハッシュ・コードを返します。
      オーバーライド:
      hashCode、クラスObject
      戻り値:
      実行可能要素のハッシュ・コードに基づくハッシュ・コード
      関連項目:

    • isNamePresent

      public boolean isNamePresent()
      パラメータがクラス・ファイルに従った名前を持つ場合はtrueを返し、そうでない場合はfalseを返します。 パラメータが名前を持つかどうかは、パラメータを宣言するメソッドのMethodParameters属性によって判定されます。
      戻り値:
      パラメータがクラス・ファイルに従った名前を持つ場合に限りtrue

    • toString

      public String toString()
      このパラメータを記述した文字列を返します。 形式は、「Java言語仕様」で推奨されている正規の順序でのパラメータの修飾子で、その後にパラメータ(パラメータが可変引数の場合の最後の[]の除外)の完全修飾型、パラメータが可変引数の場合は"..."、その後にスペース、パラメータの名前が続きます。
      オーバーライド:
      toString、クラスObject
      戻り値:
      パラメータおよび関連情報の文字列表現

    • getDeclaringExecutable

      public Executable getDeclaringExecutable()
      このパラメータを宣言するExecutableを返します。
      戻り値:
      このパラメータを宣言するExecutable

    • getModifiers

      public int getModifiers()
      このオブジェクトによって表されるパラメータのJava言語modifiersを返します。
      戻り値:
      このオブジェクトで表されるパラメータのJava言語modifiers
      Java言語仕様を参照してください:
      8.4.1 仮パラメータ
      関連項目:

    • accessFlags

      public Set<AccessFlag> accessFlags()
      このオブジェクトによって表されるパラメータに対して、変更できない「アクセス・フラグ」のセットを返します(空の場合もあります)。
      戻り値:
      このオブジェクトによって表されるパラメータに対する変更できない「アクセス・フラグ」のセット。空の場合もあります
      Java Virtual Machine仕様を参照してください:
      「4.7.24 MethodParameters属性」
      導入されたバージョン:
      20
      関連項目:

    • getName

      public String getName()
      パラメータの名前を返します。 パラメータの名前が存在する場合、このメソッドはクラス・ファイルによって提供される名前を返します。 そうでない場合、このメソッドはargNという形式の名前を合成します。ここでNは、パラメータを宣言するメソッドの記述子におけるパラメータのインデックスです。
      戻り値:
      パラメータの名前。クラス・ファイルによって提供されるか、クラス・ファイルが名前を提供しない場合は合成される。

    • getParameterizedType

      public Type getParameterizedType()
      Parameterオブジェクトで表されるパラメータのパラメータ化された型を識別するTypeオブジェクトを返します。
      戻り値:
      このオブジェクトが表すパラメータのパラメータ化された型を識別するTypeオブジェクト

    • getType

      public Class<?> getType()
      このParameterオブジェクトによって表されるパラメータの宣言された型を識別するClassオブジェクトを返します。
      戻り値:
      このオブジェクトが表すパラメータの宣言型を識別するClassオブジェクト

    • getAnnotatedType

      public AnnotatedType getAnnotatedType()
      このParameterによって表される仮パラメータの型を指定する型の使用を表すAnnotatedTypeオブジェクトを返します。
      戻り値:
      このParameterによって表される仮パラメータの型を指定する型の使用を表すAnnotatedTypeオブジェクト

    • isImplicit

      public boolean isImplicit()
      このパラメータがソース・コードで暗黙的に宣言されている場合はtrueを返し、そうでない場合はfalseを返します。
      戻り値:
      このパラメータが「Java言語仕様」で定義されたとおりに暗黙的に宣言されている場合にのみtrue。

    • isSynthetic

      public boolean isSynthetic()
      このパラメータがソース・コードで暗黙的にも明示的にも宣言されていない場合はtrueを返し、そうでない場合はfalseを返します。
      戻り値:
      このパラメータが「Java言語仕様」で定義された合成コンストラクトである場合にのみtrue。
      Java言語仕様を参照してください:
      13.1 バイナリの形式
      関連項目:

    • isVarArgs

      public boolean isVarArgs()
      このパラメータが可変引数リストを表す場合はtrueを返し、そうでない場合はfalseを返します。
      戻り値:
      このパラメータが可変引数リストを表す場合に限りtrue

    • getAnnotation

      public <T extends Annotation> T getAnnotation(Class<T> annotationClass)
      存在する場合は、この要素の指定された型の注釈を返し、そうでない場合はnullを返します。

      このメソッドによって返される注釈は宣言注釈であることに注意してください。

      定義:
      getAnnotation、インタフェースAnnotatedElement
      型パラメータ:
      T - 照会し、存在する場合に返す注釈の型。
      パラメータ:
      annotationClass - 注釈型に対応するClassオブジェクト
      戻り値:
      存在する場合は、この要素の指定された注釈型の注釈。そうでない場合はnull
      例外:
      NullPointerException - 指定された注釈クラスがnullの場合

    • getAnnotationsByType

      public <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)
      この要素に関連付けられている注釈を返します。 この要素に関連付けられている注釈がない場合、戻り値は長さ0の配列です。 このメソッドとAnnotatedElement.getAnnotation(Class)の違いは、引数が「繰返し可能な注釈タイプ」 (JLS 9.6)であるかどうかをこのメソッドが検出し、その場合、"検索"がコンテナ注釈を使用してそのタイプの注釈を検索しようとすることです。 このメソッドの呼出し元は、返された配列を自由に変更することができ、これはほかの呼出し元に返された配列に影響を及ぼしません。

      このメソッドによって返される注釈は宣言注釈であることに注意してください。

      定義:
      getAnnotationsByType、インタフェースAnnotatedElement
      型パラメータ:
      T - 照会し、存在する場合に返す注釈の型。
      パラメータ:
      annotationClass - 注釈型に対応するClassオブジェクト
      戻り値:
      この要素に関連付けられている場合は、この要素の指定された注釈型のすべての注釈。そうでない場合は長さ0の配列
      例外:
      NullPointerException - 指定された注釈クラスがnullの場合

    • getDeclaredAnnotations

      public Annotation[] getDeclaredAnnotations()
      この要素に直接存在する注釈を返します。 このメソッドは継承された注釈を無視します。 この要素に直接存在する注釈がない場合、戻り値は長さ0の配列です。 このメソッドの呼出し元は、返された配列を自由に変更することができ、これはほかの呼出し元に返された配列に影響を及ぼしません。

      このメソッドによって返される注釈は宣言注釈であることに注意してください。

      定義:
      getDeclaredAnnotations、インタフェースAnnotatedElement
      戻り値:
      この要素に直接存在する注釈

    • getDeclaredAnnotation

      public <T extends Annotation> T getDeclaredAnnotation(Class<T> annotationClass)
      直接存在する場合は、この要素の指定された型の注釈を返し、そうでない場合はnullを返します。 このメソッドは継承された注釈を無視します。 (この要素に直接存在する注釈がない場合は、nullを返します。)

      このメソッドによって返される注釈は宣言注釈であることに注意してください。

      定義:
      getDeclaredAnnotation、インタフェースAnnotatedElement
      型パラメータ:
      T - 照会し、直接存在する場合に返す注釈の型。
      パラメータ:
      annotationClass - 注釈型に対応するClassオブジェクト
      戻り値:
      直接存在する場合は、この要素の指定された注釈型の注釈。そうでない場合はnull
      例外:
      NullPointerException - 指定された注釈クラスがnullの場合

    • getDeclaredAnnotationsByType

      public <T extends Annotation> T[] getDeclaredAnnotationsByType(Class<T> annotationClass)
      直接存在するか間接的に存在する場合は、この要素の指定された型の注釈を返します。 このメソッドは継承された注釈を無視します。 この要素に直接または間接的に存在する指定された注釈がない場合、戻り値は長さ0の配列です。 このメソッドとAnnotatedElement.getDeclaredAnnotation(Class)の違いは、引数が「繰返し可能な注釈タイプ」 (JLS 9.6)であるかどうかをこのメソッドが検出し、ある場合は"検索"がコンテナ注釈(存在する場合)を検出しようとする点です。 このメソッドの呼出し元は、返された配列を自由に変更することができ、これはほかの呼出し元に返された配列に影響を及ぼしません。

      このメソッドによって返される注釈は宣言注釈であることに注意してください。

      定義:
      getDeclaredAnnotationsByType、インタフェースAnnotatedElement
      型パラメータ:
      T - 照会し、直接または間接的に存在する場合に返す注釈の型。
      パラメータ:
      annotationClass - 注釈型に対応するClassオブジェクト
      戻り値:
      この要素に直接または間接的に存在する場合は、この要素の指定された注釈型のすべての注釈。そうでない場合は長さ0の配列
      例外:
      NullPointerException - 指定された注釈クラスがnullの場合

    • getAnnotations

      public Annotation[] getAnnotations()
      この要素に存在する注釈を返します。 この要素に存在する注釈がない場合、戻り値は長さ0の配列です。 このメソッドの呼出し元は、返された配列を自由に変更することができ、これはほかの呼出し元に返された配列に影響を及ぼしません。

      このメソッドによって返される注釈は宣言注釈であることに注意してください。

      定義:
      getAnnotations、インタフェースAnnotatedElement
      戻り値:
      この要素に存在する注釈