Класс MethodType
- Все реализованные интерфейсы:
-
Serializable,Constable,TypeDescriptor,TypeDescriptor.OfMethod<Class<?>,MethodType>
public final class MethodType extends Object implements Constable, TypeDescriptor.OfMethod<Class<?>,MethodType>, Serializable
MethodHandle.invokeExact и MethodHandle.invoke, и во время выполнения инструкций invokedynamic. Структура представляет собой возвращаемый тип, сопровождаемый любым количеством типов параметров. Типы (примитивные, void, и ссылочные) представлены объектами Class. (Для простоты изложения мы рассматриваем void как если бы это был тип. На самом деле, он обозначает отсутствие возвращаемого типа.)
Все экземпляры MethodType неизменяемы. Два экземпляра полностью взаимозаменяемы, если они равны. Равенство зависит от взаимно-однозначного соответствия возвращаемого и типов параметров и ни от чего больше.
Этот тип может быть создан только методами-фабриками. Все методы-фабрики могут кэшировать значения, хотя кэширование не гарантируется. Некоторые методы-фабрики являются статическими, а другие — виртуальными методами, которые изменяют прекурсорные типы методов, например, путем изменения выбранного параметра.
Методы-фабрики, которые работают с группами типов параметров, систематически представлены в двух версиях, так что для работы с группами типов параметров можно использовать как массивы Java, так и списки Java. Методы запроса parameterArray и parameterList также предоставляют выбор между массивами и списками.
Объекты MethodType иногда выводятся из инструкций байткода, таких как invokedynamic, в частности, из строк описания типов, связанных с инструкциями в пуле констант файла класса.
Как классы и строки, типы методов также могут быть представлены непосредственно в пуле констант файла класса в виде констант. Тип метода может быть загружен инструкцией ldc, которая ссылается на соответствующую запись пула констант CONSTANT_MethodType. Запись ссылается на CONSTANT_Utf8 написание строки-дескриптора. (Полные сведения о константах типа метода см. в разделах 4.4.8 и 5.4.3.5 спецификации виртуальной машины Java.)
Когда JVM материализует MethodType из строки-дескриптора, все классы, указанные в дескрипторе, должны быть доступны и будут загружены. (Но классы не обязательно должны быть инициализированы, как это происходит с CONSTANT_Class.) Эта загрузка может произойти в любое время до того, как объект MethodType будет впервые получен.
Тип MethodType может быть описан в номинальной форме только в том случае, если все типы параметров и возвращаемый тип могут быть описаны с помощью nominal descriptor, представленного ClassDesc. Если тип метода может быть описан номинально, то:
- Тип метода имеет
nominal descriptor, возвращаемыйMethodType::describeConstable. - Строка-дескриптор, возвращаемая
MethodType::descriptorStringилиMethodType::toMethodDescriptorStringдля типа метода, является дескриптором метода (JVMS 4.3.3).
Если любой из типов параметров или возвращаемый тип не может быть описан номинально, т. е. Class::describeConstable возвращает пустой необязательный параметр для этого типа, то тип метода не может быть описан номинально:
- Тип метода не имеет
nominal descriptorиMethodType::describeConstableвозвращает пустой необязательный параметр. - Строка-дескриптор, возвращаемая
MethodType::descriptorStringилиMethodType::toMethodDescriptorStringдля типа метода, не является дескриптором типа.
- С момента:
- 1.7
- См. также:
Краткое описание вложенных классов
Вложенные классы/интерфейсы, объявленные в интерфейсе java.lang.invoke.TypeDescriptor
TypeDescriptor.OfField<F extends TypeDescriptor.OfField<F>>, TypeDescriptor.OfMethod<F extends TypeDescriptor.OfField<F>, M extends TypeDescriptor.OfMethod<F, M>>
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
MethodType |
appendParameterTypes |
Находит или создаёт тип метода с дополнительными типами параметров. |
MethodType |
appendParameterTypes |
Находит или создаёт тип метода с дополнительными типами параметров. |
MethodType |
changeParameterType |
Находит или создаёт тип метода с одним отличным типом параметра. |
MethodType |
changeReturnType |
Находит или создаёт тип метода с другим типом возвращаемого значения. |
Optional |
describeConstable() |
Возвращает номинальный дескриптор для этого экземпляра, если его можно создать, или пустой Optional, если его создать нельзя. |
String |
descriptorString() |
Возвращает строку-дескриптор для этого типа метода. |
MethodType |
dropParameterTypes |
Находит или создаёт тип метода с некоторыми опущенными типами параметров. |
boolean |
equals |
Сравнивает указанный объект с этим типом для проверки равенства. |
MethodType |
erase() |
Стирает все типы ссылок до Object. |
static MethodType |
fromMethodDescriptorString |
Находит или создаёт экземпляр типа метода заданного дескриптора метода (JVMS 4.3.3). |
MethodType |
generic() |
Преобразует все типы, как ссылки, так и примитивные, в Object. |
static MethodType |
genericMethodType |
Находит или создаёт тип метода, все компоненты которого являются Object. |
static MethodType |
genericMethodType |
Находит или создаёт тип метода, компоненты которого являются Object, с необязательным заключительным массивом Object[]. |
int |
hashCode() |
Возвращает хэш-код для этого типа метода. |
boolean |
hasPrimitives() |
Отмечает, содержит ли этот тип примитивный аргумент или возвращаемое значение. |
boolean |
hasWrappers() |
Отмечает, содержит ли этот тип оболочечный аргумент или возвращаемое значение. |
MethodType |
insertParameterTypes |
Находит или создаёт тип метода с дополнительными типами параметров. |
MethodType |
insertParameterTypes |
Находит или создаёт тип метода с дополнительными типами параметров. |
Class |
lastParameterType() |
Возвращает последний тип параметра этого типа метода. |
static MethodType |
methodType |
Находит или создаёт тип метода с заданными компонентами. |
static MethodType |
methodType |
Находит или создаёт тип метода с заданными компонентами. |
static MethodType |
methodType |
Находит или создаёт экземпляр заданного типа метода. |
static MethodType |
methodType |
Находит или создаёт тип метода с заданными компонентами. |
static MethodType |
methodType |
Находит или создаёт тип метода с заданными компонентами. |
static MethodType |
methodType |
Находит или создаёт тип метода с заданными компонентами. |
Class<?>[] |
parameterArray() |
Представляет типы параметров в виде массива (удобный метод). |
int |
parameterCount() |
Возвращает количество типов параметров в этом типе метода. |
List |
parameterList() |
Представляет типы параметров в виде списка (удобный метод). |
Class |
parameterType |
Возвращает тип параметра по указанному индексу в этом типе метода. |
Class |
returnType() |
Возвращает тип возвращаемого значения этого типа метода. |
String |
toMethodDescriptorString() |
Возвращает строку-дескриптор для этого типа метода. |
String |
toString() |
Возвращает строковое представление типа метода в формате "(PT0,PT1...)RT". |
MethodType |
unwrap() |
Преобразует все оболочечные типы в соответствующие примитивные типы. |
MethodType |
wrap() |
Преобразует все примитивные типы в соответствующие оболочечные типы. |
Подробное описание методов
methodType
public static MethodType methodType(Class<?> rtype, Class<?>[] ptypes)
- Параметры:
-
rtype- тип возвращаемого значения -
ptypes- типы параметров - Возвращает:
- тип метода с заданными компонентами
- Исключения:
-
NullPointerException- еслиrtypeилиptypesили любой элементptypesравен null -
IllegalArgumentException- если любой элементptypesравенvoid.class
methodType
public static MethodType methodType(Class<?> rtype, List<Class<?>> ptypes)
methodType.- Параметры:
-
rtype- тип возвращаемого значения -
ptypes- типы параметров - Возвращает:
- тип метода с заданными компонентами
- Исключения:
-
NullPointerException- еслиrtypeилиptypesили любой элементptypesравен null -
IllegalArgumentException- если любой элементptypesравенvoid.class
methodType
public static MethodType methodType(Class<?> rtype, Class<?> ptype0, Class<?>... ptypes)
methodType. Тип ведущего параметра добавляется в начало остального массива.- Параметры:
-
rtype- тип возвращаемого значения -
ptype0- тип первого параметра -
ptypes- оставшиеся типы параметров - Возвращает:
- тип метода с заданными компонентами
- Исключения:
-
NullPointerException- еслиrtypeилиptype0илиptypesили любой элементptypesравен null -
IllegalArgumentException- еслиptype0илиptypesили любой элементptypesравенvoid.class
methodType
public static MethodType methodType(Class<?> rtype)
methodType. Результирующий метод не имеет типов параметров.- Параметры:
-
rtype- тип возвращаемого значения - Возвращает:
- тип метода с заданным значением возврата
- Исключения:
-
NullPointerException- еслиrtypeравен null
methodType
public static MethodType methodType(Class<?> rtype, Class<?> ptype0)
methodType. Результирующий метод имеет единственный заданный тип параметра.- Параметры:
-
rtype- тип возвращаемого значения -
ptype0- тип параметра - Возвращает:
- тип метода с заданным значением возврата и типом параметра
- Исключения:
-
NullPointerException- еслиrtypeилиptype0равны null -
IllegalArgumentException- еслиptype0равенvoid.class
methodType
public static MethodType methodType(Class<?> rtype, MethodType ptypes)
methodType. Результирующий метод имеет те же типы параметров, что и ptypes, и указанный тип возврата.- Параметры:
-
rtype- тип возвращаемого значения -
ptypes- тип метода, предоставляющий типы параметров - Возвращает:
- тип метода с заданными компонентами
- Исключения:
-
NullPointerException- еслиrtypeилиptypesравны null
genericMethodType
public static MethodType genericMethodType(int objectArgCount, boolean finalArray)
Object с необязательным заключительным массивом Object[]. Удобный метод для methodType. Все параметры и тип возвращаемого значения будут Object, за исключением конечного массива параметров, если он есть, который будет Object[].- Параметры:
-
objectArgCount- количество параметров (без учёта конечного массива параметров, если он есть) -
finalArray- наличие заключительного массива параметров типаObject[] - Возвращает:
- обобщённый тип метода, подходящий для всех вызовов с заданным количеством аргументов и собранным массивом дополнительных аргументов
- Исключения:
-
IllegalArgumentException- еслиobjectArgCountотрицательно или больше 255 (или 254, еслиfinalArrayистинно) - См. также:
genericMethodType
public static MethodType genericMethodType(int objectArgCount)
Object. Удобный метод для methodType. Все параметры и тип возвращаемого значения будут Object.- Параметры:
-
objectArgCount- количество параметров - Возвращает:
- обобщённый тип метода, подходящий для всех вызовов с заданным количеством аргументов
- Исключения:
-
IllegalArgumentException- еслиobjectArgCountотрицательно или больше 255 - См. также:
changeParameterType
public MethodType changeParameterType(int num, Class<?> nptype)
methodType.- Определено в:
-
changeParameterTypeв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Параметры:
-
num- индекс (нумерация с нуля) типа параметра для изменения -
nptype- новый тип параметра для замены старого - Возвращает:
- тот же тип, но с изменённым выбранным параметром
- Исключения:
-
IndexOutOfBoundsException- еслиnumне является допустимым индексом вparameterArray() -
IllegalArgumentException- еслиnptypeравенvoid.class -
NullPointerException- еслиnptypeравен null
insertParameterTypes
public MethodType insertParameterTypes(int num, Class<?>... ptypesToInsert)
methodType.- Определено в:
-
insertParameterTypesв интерфейсеTypeDescriptor.OfMethod<Class<?>,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.- Определено в:
-
dropParameterTypesв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Параметры:
-
start- индекс (нумерация с нуля) первого типа параметра для удаления -
end- индекс (больше чемstart) первого типа параметра после, который не нужно удалять - Возвращает:
- тот же тип, за исключением удаленных параметров
- Исключение:
-
IndexOutOfBoundsException- еслиstartотрицательное или больше чемparameterCount(), или еслиendотрицательное или больше чемparameterCount(), или еслиstartбольше чемend
changeReturnType
public MethodType changeReturnType(Class<?> nrtype)
methodType.- Определено в:
-
changeReturnTypeв интерфейсеTypeDescriptor.OfMethod<Class<?>,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)
- Определено в:
-
parameterTypeв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Параметры:
-
num- индекс (нумерация с нуля) нужного типа параметра - Возвращает:
- выбранный тип параметра
- Исключение:
-
IndexOutOfBoundsException- еслиnumне является допустимым индексом вparameterArray()
parameterCount
public int parameterCount()
- Определено в:
-
parameterCountв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Возвращает:
- количество типов параметров
returnType
public Class<?> returnType()
- Определено в:
-
returnTypeв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Возвращает:
- тип возвращаемого значения
parameterList
public List<Class<?>> parameterList()
- Определено в:
-
parameterListв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Возвращает:
- типы параметров (в виде неизменяемого списка)
lastParameterType
public Class<?> lastParameterType()
void.class.- Примечание API:
Значение-маркер выбрано таким образом, чтобы рефлексивные запросы могли быть сделаны непосредственно к результатному значению. Значение-маркер не может быть перепутано с реальным параметром, так как
voidникогда не является допустимым типом параметра. Для режимов вызова с переменным числом аргументов полезно выражениеlastParameterType().getComponentType()для запроса типа параметра "varargs".- Возвращает:
- последний тип параметра, если он есть, иначе
void.class - С:
- 10
parameterArray
public Class<?>[] parameterArray()
- Определено в:
-
parameterArrayв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Возвращает:
- типы параметров (в виде свежей копии, если необходимо)
equals
public boolean equals(Object x)
true тогда и только тогда, когда указанный объект также является типом метода с точно такими же параметрами и типом возвращаемого значения.- Переопределяет:
-
equalsв классеObject - Параметры:
-
x- объект для сравнения - Возвращает:
-
trueесли этот объект такой же как аргумент obj;falseв противном случае. - См. также:
hashCode
public int hashCode()
- Переопределяет:
-
hashCodeв классеObject - Возвращает:
- значение хэша для этого типа метода
- См. также:
toString
public String toString()
"(PT0,PT1...)RT". Строковое представление типа метода — это заключённый в скобки, разделённый запятыми список имён типов, непосредственно за которым следует тип возвращаемого значения. Каждое имя типа представлено его simple name.
- Переопределяет:
-
toStringв классеObject - Возвращает:
- строковое представление объекта.
fromMethodDescriptorString
public static MethodType fromMethodDescriptorString(String descriptor, ClassLoader loader) throws IllegalArgumentException, TypeNotPresentException
methodType. Любое имя класса или интерфейса, вставленное в строку описания, будет разрешено с помощью заданного загрузчика (или, если он null, с помощью системного загрузчика классов).- Примечание API:
- Возможны типы методов, имеющие допустимые описания, но не могут быть построены этим методом, потому что их составные типы не видны из общего загрузчика классов.
Этот метод включён для удобства приложений, которые должны генерировать байткоды, обрабатывающие дескрипторы методов и
invokedynamic. - Параметры:
-
descriptor- строка описания метода -
loader- загрузчик классов для поиска типов - Возвращает:
- тип метода по заданному описанию метода
- Исключение:
-
NullPointerException- если строкаnull -
IllegalArgumentException- если строка не является описанием метода -
TypeNotPresentException- если именованный тип не найден -
SecurityException- если менеджер безопасности присутствует иloadernullи у вызывающего объекта нет разрешенияRuntimePermission("getClassLoader") - См. Спецификацию Java Virtual Machine:
- 4.3.3 Описания методов
toMethodDescriptorString
public String toMethodDescriptorString()
MethodType::descriptorString.- Примечание API:
- Это не строгая обратная функция для
fromMethodDescriptorString, которая требует описателя типа метода (JVMS 4.3.3) и соответствующего аргумента загрузчика классов. Два различных объектаMethodTypeмогут иметь идентичную строку описателя, так как разные классы могут иметь одинаковое имя, но разные загрузчики классов.Этот метод включен для удобства приложений, которые должны генерировать байткоды, обрабатывающие дескрипторы методов и
invokedynamic. - Возвращает:
- строку-описатель для этого типа метода
- См. Спецификацию виртуальной машины Java:
- 4.3.3 Описатели методов
- См. также:
descriptorString
public String descriptorString()
Если этот тип метода может быть номинально описан, то результатом является описатель типа метода (JVMS 4.3.3). MethodTypeDesc для этого типа метода можно получить, вызвав MethodTypeDesc::ofDescriptor со строкой результирующего описателя.
Если этот тип метода нельзя номинально описать, и результатом является строка вида:
"(<parameter-descriptors>)<return-descriptor>" где <parameter-descriptors> — конкатенация строки-описателя всех типов параметров и строки-описателя типа возвращаемого значения. Из этой результирующей строки нельзя получить MethodTypeDesc.- Определено в:
-
descriptorStringв интерфейсеTypeDescriptor - Возвращает:
- строку-описатель для этого типа метода
- См. Спецификацию виртуальной машины Java:
- 4.3.3 Описатели методов
- С:
- 12
- См. также:
describeConstable
public Optional<MethodTypeDesc> describeConstable()
Optional, если его нельзя создать.- Определено в:
-
describeConstableв интерфейсеConstable - Возвращает:
- An
Optionalсодержащий результирующий номинальный описатель или пустойOptional, если его нельзя создать. - С:
- 12
- См. также:
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/invoke/MethodType.html