MethodParameter (Spring Framework 5.0.3.RELEASE API)

java.lang.Object
- org.springframework.core.MethodParameter

既知の直属サブクラス
SynthesizingMethodParameter
```
public class MethodParameter
extends java.lang.Object
```
メソッドパラメーターの仕様をカプセル化するヘルパークラス、つまり、Method または Constructor に加えて、宣言されたジェネリクス型のパラメーターインデックスとネストされた型インデックス。渡すための仕様オブジェクトとして有用です。
4.2 の時点で、属性エイリアスを使用してアノテーションを合成する SynthesizingMethodParameter サブクラスが利用可能です。そのサブクラスは、特に Web およびメッセージエンドポイントの処理に使用されます。
導入:
2.0
作成者:
Juergen Hoeller, Rob Harrop, Andy Clement, Sam Brannen, Sebastien Deleuze
関連事項:
SynthesizingMethodParameter

コンストラクターの概要

コンストラクター
コンストラクターと説明
`MethodParameter(java.lang.reflect.Constructor<?> constructor, int parameterIndex)` ネストレベル 1 で、指定されたコンストラクターの新しい MethodParameter を作成します。
`MethodParameter(java.lang.reflect.Constructor<?> constructor, int parameterIndex, int nestingLevel)` 指定されたコンストラクターの新しい MethodParameter を作成します。
`MethodParameter(java.lang.reflect.Method method, int parameterIndex)` ネストレベル 1 で、指定されたメソッドの新しい `MethodParameter` を作成します。
`MethodParameter(java.lang.reflect.Method method, int parameterIndex, int nestingLevel)` 指定されたメソッドの新しい `MethodParameter` を作成します。
`MethodParameter(MethodParameter original)` コピーコンストラクター。元のオブジェクトと同じメタデータとキャッシュ状態に基づいて、独立した MethodParameter オブジェクトを作成します。

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`protected <A extends java.lang.annotation.Annotation> A`	`adaptAnnotation(A annotation)` 呼び出し元に返す前に特定のアノテーションインスタンスを後処理するテンプレートメソッド。
`protected java.lang.annotation.Annotation[]`	`adaptAnnotationArray(java.lang.annotation.Annotation[] annotations)` 呼び出し元に返す前に特定のアノテーション配列を後処理するテンプレートメソッド。
`MethodParameter`	`clone()`
`void`	`decreaseNestingLevel()` このパラメーターのネストレベルを下げます。
`boolean`	`equals(java.lang.Object other)`
`protected static int`	`findParameterIndex(java.lang.reflect.Parameter parameter)`
`static MethodParameter`	`forExecutable(java.lang.reflect.Executable executable, int parameterIndex)` 指定されたメソッドまたはコンストラクターの新しい MethodParameter を作成します。
`static MethodParameter`	`forMethodOrConstructor(java.lang.Object methodOrConstructor, int parameterIndex)` 使用すべきではありません。 5.0 現在、`forExecutable(java.lang.reflect.Executable, int)` を推奨
`static MethodParameter`	`forParameter(java.lang.reflect.Parameter parameter)` 指定されたパラメーター記述子の新しい MethodParameter を作成します。
`java.lang.reflect.AnnotatedElement`	`getAnnotatedElement()` ラップされたアノテーション付き要素を返します。
`java.lang.reflect.Constructor<?>`	`getConstructor()` ラップされたコンストラクターがある場合はそれを返します。
`java.lang.Class<?>`	`getContainingClass()`
`java.lang.Class<?>`	`getDeclaringClass()` 基になるメソッドまたはコンストラクターを宣言するクラスを返します。
`java.lang.reflect.Executable`	`getExecutable()` ラップされた実行可能ファイルを返します。
`java.lang.reflect.Type`	`getGenericParameterType()` メソッド / コンストラクターパラメーターのジェネリクス型を返します。
`java.lang.reflect.Member`	`getMember()` ラップされたメンバーを返します。
`java.lang.reflect.Method`	`getMethod()` ラップされたメソッドがあれば返します。
`<A extends java.lang.annotation.Annotation> A`	`getMethodAnnotation(java.lang.Class<A> annotationType)` 可能な場合、指定された型のメソッド / コンストラクターアノテーションを返します。
`java.lang.annotation.Annotation[]`	`getMethodAnnotations()` ターゲットメソッド / コンストラクター自体に関連付けられているアノテーションを返します。
`java.lang.reflect.Type`	`getNestedGenericParameterType()` メソッド / コンストラクターパラメーターのネストされたジェネリクス型を返します。
`java.lang.Class<?>`	`getNestedParameterType()` メソッド / コンストラクターパラメーターのネストされた型を返します。
`int`	`getNestingLevel()` ターゲット型のネストレベルを返します（通常は 1。
`java.lang.reflect.Parameter`	`getParameter()` メソッド / コンストラクターパラメーターの `Parameter` 記述子を返します。
`<A extends java.lang.annotation.Annotation> A`	`getParameterAnnotation(java.lang.Class<A> annotationType)` 使用可能な場合、指定された型のパラメーターアノテーションを返します。
`java.lang.annotation.Annotation[]`	`getParameterAnnotations()` 特定のメソッド / コンストラクターパラメーターに関連付けられているアノテーションを返します。
`int`	`getParameterIndex()` メソッド / コンストラクターパラメーターのインデックスを返します。
`java.lang.String`	`getParameterName()` メソッド / コンストラクターのパラメーターの名前を返します。
`java.lang.Class<?>`	`getParameterType()` メソッド / コンストラクターのパラメーターの型を返します。
`java.lang.Integer`	`getTypeIndexForCurrentLevel()` 現在のネストレベルの型インデックスを返します。
`java.lang.Integer`	`getTypeIndexForLevel(int nestingLevel)` 指定されたネストレベルの型インデックスを返します。
`int`	`hashCode()`
`<A extends java.lang.annotation.Annotation> boolean`	`hasMethodAnnotation(java.lang.Class<A> annotationType)` メソッド / コンストラクターに指定された型のアノテーションが付けられているかどうかを返します。
`<A extends java.lang.annotation.Annotation> boolean`	`hasParameterAnnotation(java.lang.Class<A> annotationType)` 指定されたアノテーション型でパラメーターが宣言されているかどうかを返します。
`boolean`	`hasParameterAnnotations()` パラメーターに少なくとも 1 つのアノテーションがある場合は `true` を返し、ない場合は `false` を返します。
`void`	`increaseNestingLevel()` このパラメーターのネストレベルを上げます。
`void`	`initParameterNameDiscovery(ParameterNameDiscoverer parameterNameDiscoverer)` このメソッドパラメーターのパラメーター名の検出を初期化します。
`boolean`	`isOptional()` このメソッドが不要なパラメーターを示しているかどうかを返します: Java 8 の `Optional` の形式、パラメーターレベルの `Nullable` アノテーションのバリエーション（JSR-305 または FindBugs のアノテーションセットなど）、または言語レベルの null 可能 Kotlin の型宣言。
`MethodParameter`	`nested()` この `MethodParameter` のバリアントを返します。これは、同じパラメーターを指しますが、ネストレベルが 1 つ深くなります。
`MethodParameter`	`nestedIfOptional()` `Optional` 宣言の場合、同じパラメーターを指しますが、ネストレベルが 1 つ深いこの `MethodParameter` のバリアントを返します。
`void`	`setTypeIndexForCurrentLevel(int typeIndex)` 現在のネストレベルの型インデックスを設定します。
`java.lang.String`	`toString()`

クラス java.lang.Object から継承されたメソッド
finalize, getClass, notify, notifyAll, wait, wait, wait

- コンストラクターの詳細
  - MethodParameter
```
public MethodParameter(java.lang.reflect.Method method,
                       int parameterIndex)
```
    ネストレベル 1 で、指定されたメソッドの新しい MethodParameter を作成します。
    パラメーター:
    method - パラメーターを指定するメソッド
    parameterIndex - パラメーターのインデックス: メソッドの戻り値の型の場合は -1。最初のメソッドパラメーターの場合は 0。2 番目のメソッドパラメーターなどの場合は 1
  - MethodParameter
```
public MethodParameter(java.lang.reflect.Method method,
                       int parameterIndex,
                       int nestingLevel)
```
    指定されたメソッドの新しい MethodParameter を作成します。
    パラメーター:
    method - パラメーターを指定するメソッド
    parameterIndex - パラメーターのインデックス: メソッドの戻り値の型の場合は -1。最初のメソッドパラメーターの場合は 0。2 番目のメソッドパラメーターなどの場合は 1
    nestingLevel - ターゲット型のネストレベル (通常 1。たとえばリストのリストの場合、1 はネストされたリストを示し、2 はネストされたリストの要素を示します)
  - MethodParameter
```
public MethodParameter(java.lang.reflect.Constructor<?> constructor,
                       int parameterIndex)
```
    ネストレベル 1 で、指定されたコンストラクターの新しい MethodParameter を作成します。
    パラメーター:
    constructor - パラメーターを指定するコンストラクター
    parameterIndex - パラメーターのインデックス
  - MethodParameter
```
public MethodParameter(java.lang.reflect.Constructor<?> constructor,
                       int parameterIndex,
                       int nestingLevel)
```
    指定されたコンストラクターの新しい MethodParameter を作成します。
    パラメーター:
    constructor - パラメーターを指定するコンストラクター
    parameterIndex - パラメーターのインデックス
    nestingLevel - ターゲット型のネストレベル (通常 1。たとえばリストのリストの場合、1 はネストされたリストを示し、2 はネストされたリストの要素を示します)
  - MethodParameter
```
public MethodParameter(MethodParameter original)
```
    コピーコンストラクター。元のオブジェクトと同じメタデータとキャッシュ状態に基づいて、独立した MethodParameter オブジェクトを作成します。
    パラメーター:
    original - コピー元の MethodParameter オブジェクト
- メソッドの詳細
  - getMethod
```
@Nullable
public java.lang.reflect.Method getMethod()
```
    ラップされたメソッドがあれば返します。
    メモ: Method または Constructor のいずれかを使用できます。
    戻り値:
    メソッド、または存在しない場合は null
  - getConstructor
```
@Nullable
public java.lang.reflect.Constructor<?> getConstructor()
```
    ラップされたコンストラクターがある場合はそれを返します。
    メモ: Method または Constructor のいずれかを使用できます。
    戻り値:
    コンストラクター、または存在しない場合は null
  - getDeclaringClass
```
public java.lang.Class<?> getDeclaringClass()
```
    基になるメソッドまたはコンストラクターを宣言するクラスを返します。
  - getMember
```
public java.lang.reflect.Member getMember()
```
    ラップされたメンバーを返します。
    戻り値:
    メンバーとしてのメソッドまたはコンストラクター
  - getAnnotatedElement
```
public java.lang.reflect.AnnotatedElement getAnnotatedElement()
```
    ラップされたアノテーション付き要素を返します。
    メモ: このメソッドは、メソッド / コンストラクター自体で（つまり、パラメーターレベルではなく、メソッド / コンストラクターレベルで）宣言されたアノテーションを公開します。
    戻り値:
    AnnotatedElement としてのメソッドまたはコンストラクター
  - getExecutable
```
public java.lang.reflect.Executable getExecutable()
```
    ラップされた実行可能ファイルを返します。
    戻り値:
    メソッドまたはコンストラクターを実行可能ファイルとして
    導入:
    5.0
  - getParameter
```
public java.lang.reflect.Parameter getParameter()
```
    メソッド / コンストラクターパラメーターの Parameter 記述子を返します。
    導入:
    5.0
  - getParameterIndex
```
public int getParameterIndex()
```
    メソッド / コンストラクターパラメーターのインデックスを返します。
    戻り値:
    パラメーターインデックス (-1 戻り型の場合)
  - increaseNestingLevel
```
public void increaseNestingLevel()
```
    このパラメーターのネストレベルを上げます。
    関連事項:
    getNestingLevel()
  - decreaseNestingLevel
```
public void decreaseNestingLevel()
```
    このパラメーターのネストレベルを下げます。
    関連事項:
    getNestingLevel()
  - getNestingLevel
```
public int getNestingLevel()
```
    ターゲット型のネストレベルを返します（通常 1。たとえば、リストのリストの場合、1 はネストされたリストを示し、2 はネストされたリストの要素を示します）。
  - setTypeIndexForCurrentLevel
```
public void setTypeIndexForCurrentLevel(int typeIndex)
```
    現在のネストレベルの型インデックスを設定します。
    パラメーター:
    typeIndex - 対応する型インデックス (または、デフォルトの型インデックスの場合は null )
    関連事項:
    getNestingLevel()
  - getTypeIndexForCurrentLevel
```
@Nullable
public java.lang.Integer getTypeIndexForCurrentLevel()
```
    現在のネストレベルの型インデックスを返します。
    戻り値:
    対応する型インデックス、または指定されていない場合は null (デフォルトの型インデックスを示す)
    関連事項:
    getNestingLevel()
  - getTypeIndexForLevel
```
@Nullable
public java.lang.Integer getTypeIndexForLevel(int nestingLevel)
```
    指定されたネストレベルの型インデックスを返します。
    パラメーター:
    nestingLevel - チェックするネストレベル
    戻り値:
    対応する型インデックス、または指定されていない場合は null (デフォルトの型インデックスを示す)
  - nested
```
public MethodParameter nested()
```
    この MethodParameter のバリアントを返します。これは、同じパラメーターを指しますが、ネストレベルが 1 つ深くなります。これは実質的に increaseNestingLevel() と同じですが、独立した MethodParameter オブジェクトがあるだけです（たとえば、オリジナルがキャッシュされている場合）。
    導入:
    4.3
  - isOptional
```
public boolean isOptional()
```
    このメソッドが不要なパラメーターを示しているかどうかを返します: Java 8 の Optional の形式、パラメーターレベルの Nullable アノテーションのバリエーション（JSR-305 または FindBugs のアノテーションセットなど）、または言語レベルの null 可能 Kotlin の型宣言。
    導入:
    4.3
  - nestedIfOptional
```
public MethodParameter nestedIfOptional()
```
    Optional 宣言の場合、同じパラメーターを指しますが、ネストレベルが 1 つ深いこの MethodParameter のバリアントを返します。
    導入:
    4.3
    関連事項:
    isOptional(), nested()
  - getContainingClass
```
public java.lang.Class<?> getContainingClass()
```
  - getParameterType
```
public java.lang.Class<?> getParameterType()
```
    メソッド / コンストラクターのパラメーターの型を返します。
    戻り値:
    パラメーター型 (非 null)
  - getGenericParameterType
```
public java.lang.reflect.Type getGenericParameterType()
```
    メソッド / コンストラクターパラメーターのジェネリクス型を返します。
    戻り値:
    パラメーター型 (非 null)
    導入:
    3.0
  - getNestedParameterType
```
public java.lang.Class<?> getNestedParameterType()
```
    メソッド / コンストラクターパラメーターのネストされた型を返します。
    戻り値:
    パラメーター型 (非 null)
    導入:
    3.1
    関連事項:
    getNestingLevel()
  - getNestedGenericParameterType
```
public java.lang.reflect.Type getNestedGenericParameterType()
```
    メソッド / コンストラクターパラメーターのネストされたジェネリクス型を返します。
    戻り値:
    パラメーター型 (非 null)
    導入:
    4.2
    関連事項:
    getNestingLevel()
  - getMethodAnnotations
```
public java.lang.annotation.Annotation[] getMethodAnnotations()
```
    ターゲットメソッド / コンストラクター自体に関連付けられているアノテーションを返します。
  - getMethodAnnotation
```
@Nullable
public <A extends java.lang.annotation.Annotation> A getMethodAnnotation(java.lang.Class<A> annotationType)
```
    可能な場合、指定された型のメソッド / コンストラクターアノテーションを返します。
    パラメーター:
    annotationType - 検索するアノテーション型
    戻り値:
    アノテーションオブジェクト、または見つからない場合は null
  - hasMethodAnnotation
```
public <A extends java.lang.annotation.Annotation> boolean hasMethodAnnotation(java.lang.Class<A> annotationType)
```
    メソッド / コンストラクターに指定された型のアノテーションが付けられているかどうかを返します。
    パラメーター:
    annotationType - 検索するアノテーション型
    導入:
    4.3
    関連事項:
    getMethodAnnotation(Class)
  - getParameterAnnotations
```
public java.lang.annotation.Annotation[] getParameterAnnotations()
```
    特定のメソッド / コンストラクターパラメーターに関連付けられているアノテーションを返します。
  - hasParameterAnnotations
```
public boolean hasParameterAnnotations()
```
    パラメーターに少なくとも 1 つのアノテーションがある場合は true を返し、ない場合は false を返します。
    関連事項:
    getParameterAnnotations()
  - getParameterAnnotation
```
@Nullable
public <A extends java.lang.annotation.Annotation> A getParameterAnnotation(java.lang.Class<A> annotationType)
```
    使用可能な場合、指定された型のパラメーターアノテーションを返します。
    パラメーター:
    annotationType - 検索するアノテーション型
    戻り値:
    アノテーションオブジェクト、または見つからない場合は null
  - hasParameterAnnotation
```
public <A extends java.lang.annotation.Annotation> boolean hasParameterAnnotation(java.lang.Class<A> annotationType)
```
    指定されたアノテーション型でパラメーターが宣言されているかどうかを返します。
    パラメーター:
    annotationType - 検索するアノテーション型
    関連事項:
    getParameterAnnotation(Class)
  - initParameterNameDiscovery
```
public void initParameterNameDiscovery(@Nullable
                                       ParameterNameDiscoverer parameterNameDiscoverer)
```
    このメソッドパラメーターのパラメーター名の検出を初期化します。
    このメソッドは、実際にはこの時点でパラメーター名を取得しようとしません。アプリケーションが getParameterName() を呼び出したときにディスカバリが発生するようにします（もしあれば）。
  - getParameterName
```
@Nullable
public java.lang.String getParameterName()
```
    メソッド / コンストラクターのパラメーターの名前を返します。
    戻り値:
    パラメーター名 (クラスファイルにパラメーター名のメタデータが含まれていない場合、または ParameterNameDiscoverer が始まるように設定されていない場合は、null になります。)
  - adaptAnnotation
```
protected <A extends java.lang.annotation.Annotation> A adaptAnnotation(A annotation)
```
    呼び出し元に返す前に特定のアノテーションインスタンスを後処理するテンプレートメソッド。
    デフォルトの実装は、指定されたアノテーションをそのまま返すだけです。
    パラメーター:
    annotation - 返されるアノテーション
    戻り値:
    後処理されたアノテーション (または単に元のもの)
    導入:
    4.2
  - adaptAnnotationArray
```
protected java.lang.annotation.Annotation[] adaptAnnotationArray(java.lang.annotation.Annotation[] annotations)
```
    呼び出し元に返す前に特定のアノテーション配列を後処理するテンプレートメソッド。
    デフォルトの実装は、指定されたアノテーション配列をそのまま返すだけです。
    パラメーター:
    annotations - 返されようとしているアノテーション配列
    戻り値:
    後処理されたアノテーション配列 (または単に元のもの)
    導入:
    4.2
  - equals
```
public boolean equals(java.lang.Object other)
```
    オーバーライド:
    クラス java.lang.Object の equals
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    クラス java.lang.Object の hashCode
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    クラス java.lang.Object の toString
  - clone
```
public MethodParameter clone()
```
    オーバーライド:
    クラス java.lang.Object の clone
  - forMethodOrConstructor
```
@Deprecated
public static MethodParameter forMethodOrConstructor(java.lang.Object methodOrConstructor,
                                                                 int parameterIndex)
```
    5.0 以降は非推奨。forExecutable(java.lang.reflect.Executable, int) に置き換えられました。
    指定されたメソッドまたはコンストラクターの新しい MethodParameter を作成します。
    これは、メソッドまたはコンストラクターの参照が一般的な方法で処理されるシナリオの便利なファクトリメソッドです。
    パラメーター:
    methodOrConstructor - パラメーターを指定するメソッドまたはコンストラクター
    parameterIndex - パラメーターのインデックス
    戻り値:
    対応する MethodParameter インスタンス
  - forExecutable
```
public static MethodParameter forExecutable(java.lang.reflect.Executable executable,
                                            int parameterIndex)
```
    指定されたメソッドまたはコンストラクターの新しい MethodParameter を作成します。
    これは、メソッドまたはコンストラクターの参照が一般的な方法で処理されるシナリオの便利なファクトリメソッドです。
    パラメーター:
    executable - パラメーターを指定するメソッドまたはコンストラクター
    parameterIndex - パラメーターのインデックス
    戻り値:
    対応する MethodParameter インスタンス
    導入:
    5.0
  - forParameter
```
public static MethodParameter forParameter(java.lang.reflect.Parameter parameter)
```
    指定されたパラメーター記述子の新しい MethodParameter を作成します。
    これは、Java 8 Parameter 記述子がすでに利用可能なシナリオの便利なファクトリメソッドです。
    パラメーター:
    parameter - パラメーター記述子
    戻り値:
    対応する MethodParameter インスタンス
    導入:
    5.0
  - findParameterIndex
```
protected static int findParameterIndex(java.lang.reflect.Parameter parameter)
```

クラス MethodParameter

コンストラクターの概要

方法の概要

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

MethodParameter

MethodParameter

MethodParameter

MethodParameter

MethodParameter

メソッドの詳細

getMethod

getConstructor

getDeclaringClass

getMember

getAnnotatedElement

getExecutable

getParameter

getParameterIndex

increaseNestingLevel

decreaseNestingLevel

getNestingLevel

setTypeIndexForCurrentLevel

getTypeIndexForCurrentLevel

getTypeIndexForLevel

nested

isOptional

nestedIfOptional

getContainingClass

getParameterType

getGenericParameterType

getNestedParameterType

getNestedGenericParameterType

getMethodAnnotations

getMethodAnnotation

hasMethodAnnotation

getParameterAnnotations

hasParameterAnnotations

getParameterAnnotation

hasParameterAnnotation

initParameterNameDiscovery

getParameterName

adaptAnnotation

adaptAnnotationArray

equals

hashCode

toString

clone

forMethodOrConstructor

forExecutable

forParameter

findParameterIndex