java.lang.invoke

クラス MethodType

java.lang.Object

java.lang.invoke.MethodType

すべての実装されたインタフェース:

Serializable

public final class MethodType
extends Object
implements Serializable

メソッド型は、メソッドハンドルが受け取ったり返したりする引数や戻り値の型、あるいはメソッドハンドルの呼び出し元が渡したり期待したりする引数や戻り値の型を表します。メソッドハンドルとそのすべての呼び出し元との間でメソッド型が正しく一致する必要がありますが、JVM の操作はこの一致処理を、実行時に、具体的には MethodHandle.invokeExact や MethodHandle.invoke の呼び出し中および invokedynamic 命令の実行中に、実施します。

その構造は、戻り値の型に任意の数のパラメータの型を付加したものとなります。型 (プリミティブ、void、および参照) は Class オブジェクトで表されます。(説明が容易になるように、ここでは void を型として扱います。これは実際には、戻り値の型が存在しないことを示します。)

MethodType のすべてのインスタンスは不変です。2 つのインスタンスを比較して等しくなった場合、両者は完全に交換可能です。等しいかどうかは、戻り値とパラメータの型のペア単位の対応関係に依存し、それ以外の要素には一切依存しません。

この型を作成できるのは、ファクトリメソッドだけです。すべてのファクトリメソッドは値をキャッシングする可能性がありますが、キャッシングが実行されるという保証はありません。ファクトリメソッドの中には、静的なメソッドもあれば、(選択されたパラメータを変更するなどして) 既存のメソッド型を変更する仮想メソッドもあります。

一連のパラメータの型を操作するファクトリメソッドには体系的に 2 つのバージョンが用意されていますが、これは、一連のパラメータの型を Java の配列と Java のリストの両方で操作できるようにするためです。クエリーメソッド parameterArray と parameterList も、配列とリストの選択肢を提供しています。

MethodType オブジェクトが invokedynamic などのバイトコード命令から、具体的には、クラスファイルの定数プール内の命令に関連付けられた型記述子文字列から派生されることがあります。

メソッド型はクラスや文字列の場合と同じく、クラスファイルの定数プール内の定数として直接表現することもできます。メソッド型は、適切な CONSTANT_MethodType 定数プールエントリを参照する ldc 命令によってロードできます。そのエントリは、記述子文字列の CONSTANT_Utf8 スペリングを参照します。詳細は、パッケージのサマリーを参照してください。

JVM が記述子文字列から MethodType を実体化するときは、記述子で指定されたすべてのクラスはアクセス可能である必要があり、それらはすべてロードされます。(ただし CONSTANT_Class の場合と同じく、クラスの初期化は不要です。)このロード処理は、MethodType オブジェクトがはじめて派生されるまでの任意のタイミングで発生する可能性があります。

関連項目:

直列化された形式

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
MethodType	appendParameterTypes(Class<?>... ptypesToInsert) 追加のパラメータの型を持つメソッド型を検索または作成します。
MethodType	appendParameterTypes(List<Class<?>> ptypesToInsert) 追加のパラメータの型を持つメソッド型を検索または作成します。
MethodType	changeParameterType(int num, Class<?> nptype) 1 つのパラメータの型が異なるメソッド型を検索または作成します。
MethodType	changeReturnType(Class<?> nrtype) 戻り値の型が異なるメソッド型を検索または作成します。
MethodType	dropParameterTypes(int start, int end) いくつかのパラメータの型が削除されたメソッド型を検索または作成します。
boolean	equals(Object x) 指定されたオブジェクトがこの型と等しいかどうかを比較します。
MethodType	erase() すべての参照型を消去して Object にします。
static MethodType	fromMethodDescriptorString(String descriptor, ClassLoader loader) バイトコード記述子のスペリングに基づいてメソッド型のインスタンスを検索または作成します。
MethodType	generic() すべての型 (参照とプリミティブの両方) を Object に変換します。
static MethodType	genericMethodType(int objectArgCount) コンポーネントがすべて Object であるようなメソッド型を検索または作成します。
static MethodType	genericMethodType(int objectArgCount, boolean finalArray) Object とオプションで末尾の Object[] 配列をコンポーネントに持つメソッド型を検索または作成します。
int	hashCode() このメソッド型のハッシュコード値を返します。
boolean	hasPrimitives() この型にプリミティブの引数または戻り値が含まれているかどうかを報告します。
boolean	hasWrappers() この型にラッパーの引数または戻り値が含まれているかどうかを報告します。
MethodType	insertParameterTypes(int num, Class<?>... ptypesToInsert) 追加のパラメータの型を持つメソッド型を検索または作成します。
MethodType	insertParameterTypes(int num, List<Class<?>> ptypesToInsert) 追加のパラメータの型を持つメソッド型を検索または作成します。
static MethodType	methodType(Class<?> rtype) 指定されたコンポーネントを持つメソッド型を検索または作成します。
static MethodType	methodType(Class<?> rtype, Class<?> ptype0) 指定されたコンポーネントを持つメソッド型を検索または作成します。
static MethodType	methodType(Class<?> rtype, Class<?>[] ptypes) 指定されたメソッド型のインスタンスを検索または作成します。
static MethodType	methodType(Class<?> rtype, Class<?> ptype0, Class<?>... ptypes) 指定されたコンポーネントを持つメソッド型を検索または作成します。
static MethodType	methodType(Class<?> rtype, List<Class<?>> ptypes) 指定されたコンポーネントを持つメソッド型を検索または作成します。
static MethodType	methodType(Class<?> rtype, MethodType ptypes) 指定されたコンポーネントを持つメソッド型を検索または作成します。
Class<?>[]	parameterArray() パラメータの型を配列として提供します (簡易メソッド)。
int	parameterCount() このメソッド型に含まれるパラメータの型の数を返します。
List<Class<?>>	parameterList() パラメータの型をリストとして提供します (簡易メソッド)。
Class<?>	parameterType(int num) このメソッド型の中の指定されたインデックスのパラメータの型を返します。
Class<?>	returnType() このメソッド型の戻り値の型を返します。
String	toMethodDescriptorString() メソッド型のバイトコード記述子表現を生成します。
String	toString() メソッド型の文字列表現を "(PT0,PT1...)RT" の形式で返します。
MethodType	unwrap() すべてのラッパー型を対応するプリミティブ型に変換します。
MethodType	wrap() すべてのプリミティブ型を対応するラッパー型に変換します。

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

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

メソッドの詳細

methodType

public static MethodType methodType(Class<?> rtype,
                    Class<?>[] ptypes)

指定されたメソッド型のインスタンスを検索または作成します。

パラメータ:

rtype - 戻り値の型

ptypes - パラメータの型

戻り値:

指定されたコンポーネントを持つメソッド型

例外:

NullPointerException - rtype または ptypes が null であるか、ptypes のいずれかの要素が null である場合

IllegalArgumentException - ptypes のいずれかの要素が void.class である場合

methodType

public static MethodType methodType(Class<?> rtype,
                    List<Class<?>> ptypes)

指定されたコンポーネントを持つメソッド型を検索または作成します。methodType の簡易メソッド。

戻り値:

指定されたコンポーネントを持つメソッド型

例外:

NullPointerException - rtype または ptypes が null であるか、ptypes のいずれかの要素が null である場合

IllegalArgumentException - ptypes のいずれかの要素が void.class である場合

methodType

public static MethodType methodType(Class<?> rtype,
                    Class<?> ptype0,
                    Class<?>... ptypes)

指定されたコンポーネントを持つメソッド型を検索または作成します。methodType の簡易メソッド。先頭のパラメータの型が残りの配列の先頭に追加されます。

戻り値:

指定されたコンポーネントを持つメソッド型

例外:

NullPointerException - rtype、ptype0、ptypes のいずれかが null であるか、ptypes のいずれかの要素が null である場合

IllegalArgumentException - ptype0 または ptypes、あるいは ptypes のいずれかの要素が void.class の場合

methodType

public static MethodType methodType(Class<?> rtype)

指定されたコンポーネントを持つメソッド型を検索または作成します。methodType の簡易メソッド。結果となるメソッドにはパラメータの型は含まれません。

戻り値:

指定された戻り値を含むメソッド型

例外:

NullPointerException - rtype が null である場合

methodType

public static MethodType methodType(Class<?> rtype,
                    Class<?> ptype0)

指定されたコンポーネントを持つメソッド型を検索または作成します。methodType の簡易メソッド。結果となるメソッドには、指定された単一のパラメータの型が含まれます。

戻り値:

指定された戻り値とパラメータの型を持つメソッド型

例外:

NullPointerException - rtype または ptype0 が null の場合

IllegalArgumentException - ptype0 が void.class である場合

methodType

public static MethodType methodType(Class<?> rtype,
                    MethodType ptypes)

指定されたコンポーネントを持つメソッド型を検索または作成します。methodType の簡易メソッド。結果となるメソッドには、ptypes と同じパラメータの型と、指定された戻り値の型が含まれます。

例外:

NullPointerException - rtype または ptypes が null の場合

genericMethodType

public static MethodType genericMethodType(int objectArgCount,
                           boolean finalArray)

Object とオプションで末尾の Object[] 配列をコンポーネントに持つメソッド型を検索または作成します。methodType の簡易メソッド。パラメータと戻り値の型はすべて Object ですが、最後の配列パラメータが存在する場合はそのかぎりではなく、その型は Object[] になります。

パラメータ:

objectArgCount - パラメータの数 (最後の配列パラメータが存在する場合、それは含まない)

finalArray - Object[] 型の末尾の配列パラメータが存在するかどうか

戻り値:

指定された固定数の引数と、追加の引数が集められた 1 つの配列が渡されるすべての呼び出しに対し、汎用的に適用可能なメソッド型

例外:

IllegalArgumentException - objectArgCount が負であるか 255 (finalArray が true の場合は 254) より大きい場合

関連項目:

genericMethodType(int)

genericMethodType

public static MethodType genericMethodType(int objectArgCount)

コンポーネントがすべて Object であるようなメソッド型を検索または作成します。methodType の簡易メソッド。パラメータの型と戻り値の型はすべて Object です。

パラメータ:

objectArgCount - パラメータの数

戻り値:

指定された数の引数が渡されるすべての呼び出しに対し、汎用的に適用可能なメソッド型

例外:

IllegalArgumentException - objectArgCount が負であるか 255 より大きい場合

関連項目:

genericMethodType(int, boolean)

changeParameterType

public MethodType changeParameterType(int num,
                             Class<?> nptype)

1 つのパラメータの型が異なるメソッド型を検索または作成します。methodType の簡易メソッド。

パラメータ:

num - 変更するパラメータ型の (ゼロから始まる) インデックス

nptype - 古いパラメータの型を置き換える新しいパラメータの型

戻り値:

同じ型、ただし選択されたパラメータを変更したもの

例外:

IndexOutOfBoundsException - num が parameterArray() の有効なインデックスでない場合

IllegalArgumentException - nptype が void.class である場合

NullPointerException - nptype が null である場合

insertParameterTypes

public MethodType insertParameterTypes(int num,
                              Class<?>... ptypesToInsert)

追加のパラメータの型を持つメソッド型を検索または作成します。methodType の簡易メソッド。

パラメータ:

num - 挿入するパラメータの型の (ゼロから始まる) 位置

ptypesToInsert - パラメータリスト内に挿入するゼロ個以上の新しいパラメータの型

戻り値:

同じ型、ただし選択されたパラメータを挿入したもの

例外:

IndexOutOfBoundsException - num が負であるか parameterCount() より大きい場合

IllegalArgumentException - ptypesToInsert のいずれかの要素が void.class である場合、または結果となるメソッド型のパラメータスロット数が 255 個を超える場合

NullPointerException - ptypesToInsert またはそのいずれかの要素が null の場合

appendParameterTypes

public MethodType appendParameterTypes(Class<?>... ptypesToInsert)

追加のパラメータの型を持つメソッド型を検索または作成します。methodType の簡易メソッド。

パラメータ:

ptypesToInsert - パラメータリストの末尾のあとに挿入するゼロ個以上の新しいパラメータの型

戻り値:

同じ型、ただしその末尾に選択されたパラメータを追加したもの

例外:

IllegalArgumentException - ptypesToInsert のいずれかの要素が void.class である場合、または結果となるメソッド型のパラメータスロット数が 255 個を超える場合

NullPointerException - ptypesToInsert またはそのいずれかの要素が null の場合

insertParameterTypes

public MethodType insertParameterTypes(int num,
                              List<Class<?>> ptypesToInsert)

追加のパラメータの型を持つメソッド型を検索または作成します。methodType の簡易メソッド。

パラメータ:

num - 挿入するパラメータの型の (ゼロから始まる) 位置

ptypesToInsert - パラメータリスト内に挿入するゼロ個以上の新しいパラメータの型

戻り値:

同じ型、ただし選択されたパラメータを挿入したもの

例外:

IndexOutOfBoundsException - num が負であるか parameterCount() より大きい場合

IllegalArgumentException - ptypesToInsert のいずれかの要素が void.class である場合、または結果となるメソッド型のパラメータスロット数が 255 個を超える場合

NullPointerException - ptypesToInsert またはそのいずれかの要素が null の場合

appendParameterTypes

public MethodType appendParameterTypes(List<Class<?>> ptypesToInsert)

追加のパラメータの型を持つメソッド型を検索または作成します。methodType の簡易メソッド。

パラメータ:

ptypesToInsert - パラメータリストの末尾のあとに挿入するゼロ個以上の新しいパラメータの型

戻り値:

同じ型、ただしその末尾に選択されたパラメータを追加したもの

例外:

IllegalArgumentException - ptypesToInsert のいずれかの要素が void.class である場合、または結果となるメソッド型のパラメータスロット数が 255 個を超える場合

NullPointerException - ptypesToInsert またはそのいずれかの要素が null の場合

dropParameterTypes

public MethodType dropParameterTypes(int start,
                            int end)

いくつかのパラメータの型が削除されたメソッド型を検索または作成します。methodType の簡易メソッド。

パラメータ:

start - 削除する最初のパラメータ型の (ゼロから始まる) インデックス

end - 削除しない最初のパラメータ型の (start より大きい) インデックス

戻り値:

同じ型、ただし選択されたパラメータを削除したもの

例外:

IndexOutOfBoundsException - start が負であるか parameterCount() より大きい場合、または end が負であるか parameterCount() より大きい場合、または start が end より大きい場合

changeReturnType

public MethodType changeReturnType(Class<?> nrtype)

戻り値の型が異なるメソッド型を検索または作成します。methodType の簡易メソッド。

パラメータ:

nrtype - 古い戻り値パラメータの型を置き換える戻り値パラメータの型

戻り値:

同じ型、ただし戻り値の型を変更したもの

例外:

NullPointerException - nrtype が null である場合

hasPrimitives

public boolean hasPrimitives()

この型にプリミティブの引数または戻り値が含まれているかどうかを報告します。戻り値の型 void はプリミティブとしてカウントされます。

戻り値:

いずれかの型がプリミティブの場合は true

hasWrappers

public boolean hasWrappers()

この型にラッパーの引数または戻り値が含まれているかどうかを報告します。ラッパーとは、プリミティブ値をボクシングした型 (Integer など) のことです。参照型 java.lang.Void が戻り値の型として含まれている場合、それはラッパーとしてカウントされます。

戻り値:

いずれかの型がラッパーの場合は true

erase

public MethodType erase()

すべての参照型を消去して Object にします。methodType の簡易メソッド。すべてのプリミティブ型 (void を含む) は変更されないまま残ります。

戻り値:

元の型のすべての参照型を置き換えたバージョン

generic

public MethodType generic()

すべての型 (参照とプリミティブの両方) を Object に変換します。genericMethodType の簡易メソッド。式 type.wrap().erase() は type.generic() と同じ値を生成します。

戻り値:

元の型のすべての型を置き換えたバージョン

wrap

public MethodType wrap()

すべてのプリミティブ型を対応するラッパー型に変換します。methodType の簡易メソッド。参照型 (ラッパー型も含む) はすべて変更されずに残ります。戻り値の型 void は型 java.lang.Void に変更されます。式 type.wrap().erase() は type.generic() と同じ値を生成します。

戻り値:

元の型のすべてのプリミティブ型を置き換えたバージョン

unwrap

public MethodType unwrap()

すべてのラッパー型を対応するプリミティブ型に変換します。methodType の簡易メソッド。すべてのプリミティブ型 (void を含む) は変更されないまま残ります。戻り値の型 java.lang.Void は void に変更されます。

戻り値:

元の型のすべてのラッパー型を置き換えたバージョン

parameterType

public Class<?> parameterType(int num)

このメソッド型の中の指定されたインデックスのパラメータの型を返します。

パラメータ:

num - 目的とするパラメータの型の (ゼロから始まる) インデックス

戻り値:

選択されたパラメータの型

例外:

IndexOutOfBoundsException - num が parameterArray() の有効なインデックスでない場合

parameterCount

public int parameterCount()

このメソッド型に含まれるパラメータの型の数を返します。

戻り値:

パラメータの型の数

returnType

public Class<?> returnType()

このメソッド型の戻り値の型を返します。

戻り値:

戻り値の型

parameterList

public List<Class<?>> parameterList()

パラメータの型をリストとして提供します (簡易メソッド)。このリストは不変です。

戻り値:

パラメータの型 (不変リストとして)

parameterArray

public Class<?>[] parameterArray()

パラメータの型を配列として提供します (簡易メソッド)。この配列を変更しても、型は変更されません。

戻り値:

パラメータの型 (必要な場合は新規のコピーとして)

equals

public boolean equals(Object x)

指定されたオブジェクトがこの型と等しいかどうかを比較します。つまり、その戻り値が true になるのは、指定されたオブジェクトもまた、まったく同じパラメータと戻り値の型を持つメソッド型である場合だけです。

オーバーライド:

equals、クラス: Object

パラメータ:

x - 比較するオブジェクト

戻り値:

このオブジェクトが obj 引数と同じである場合は true、それ以外の場合は false。

関連項目:

Object.equals(Object)

hashCode

public int hashCode()

このメソッド型のハッシュコード値を返します。要素として戻り値の型のあとにパラメータの型を持つような List のハッシュコードと同じであると定義されています。

オーバーライド:

hashCode、クラス: Object

戻り値:

このメソッド型のハッシュコード値

関連項目:

Object.hashCode(), equals(Object), List.hashCode()

toString

public String toString()

メソッド型の文字列表現を "(PT0,PT1...)RT" の形式で返します。メソッド型の文字列表現は、型名のコンマ区切りリストを括弧で囲んだものの直後に、戻り値の型を付加したものになります。

各型は単純名で表現されます。

オーバーライド:

toString、クラス: Object

戻り値:

このオブジェクトの文字列表現。

fromMethodDescriptorString

public static MethodType fromMethodDescriptorString(String descriptor,
                                    ClassLoader loader)
                                             throws IllegalArgumentException,
                                                    TypeNotPresentException

バイトコード記述子のスペリングに基づいてメソッド型のインスタンスを検索または作成します。methodType の簡易メソッド。記述子文字列に埋め込まれたすべてのクラス名またはインタフェース名を解決するため、指定されたローダー (それが null の場合はシステムクラスローダー) の ClassLoader.loadClass(java.lang.String) が呼び出されます。

一般的なクラスローダーからすべてのコンポーネントの型に必ずしも到達できないため、このメソッドでは構築できないメソッド型に遭遇する可能性があります。

このメソッドが含められているのは、メソッドハンドルや invokedynamic を処理するバイトコードを生成する必要のあるアプリケーションのためです。

パラメータ:

descriptor - バイトコードレベルの型記述子の文字列「(T...)T」

loader - 型の検索先となるクラスローダー

戻り値:

バイトコードレベルの型記述子に一致するメソッド型

例外:

NullPointerException - 文字列が null の場合

IllegalArgumentException - 文字列が整形式でない場合

TypeNotPresentException - 指定された型を見つけられない場合

toMethodDescriptorString

public String toMethodDescriptorString()

メソッド型のバイトコード記述子表現を生成します。

これは厳密には、fromMethodDescriptorString の逆の操作ではありません。共通の名前を共有しているが異なるクラスローダーを持つ異なる 2 つのクラスは、記述子文字列内では同一のものと見なされます。

このメソッドが含められているのは、メソッドハンドルや invokedynamic を処理するバイトコードを生成する必要のあるアプリケーションのためです。fromMethodDescriptorString、それは、後者では適切なクラスローダーの引数が必要になるからです。

戻り値:

バイトコードの型記述子の表現