Класс 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 Virtual Machine.)
Когда JVM материализует MethodType из строки описателя, все классы, указанные в описателе, должны быть доступны и будут загружены. (Но классы не обязательно должны быть инициализированы, как в случае с CONSTANT_Class.) Эта загрузка может произойти в любое время до того, как объект 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<MethodTypeDesc> |
describeConstable() |
Возвращает номинальный дескриптор для этого экземпляра, если он может быть построен, или пустой Optional, если он не может быть построен. |
String |
descriptorString() |
Возвращает строку-дескриптор для этого типа метода. |
MethodType |
dropParameterTypes |
Находит или создаёт тип метода с пропущенными типами параметров. |
boolean |
equals |
Сравнивает указанный объект с этим типом для равенства. |
MethodType |
erase() |
Удаляет все типы ссылок до Object. |
static MethodType |
fromMethodDescriptorString |
Находит или создаёт экземпляр типа метода, исходя из записи его байткодового дескриптора. |
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<Class<?>> |
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.- Specified by:
-
dropParameterTypesв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Parameters:
-
start— индекс (нумерация с нуля) первого типа параметра для удаления -
end— индекс (больше чемstart) первого типа параметра после которого не удалять - Returns:
- тот же тип, за исключением удалённых параметров
- Throws:
-
IndexOutOfBoundsException— еслиstartотрицательное или больше чемparameterCount(), или еслиendотрицательное или больше чемparameterCount(), или еслиstartбольше чемend
changeReturnType
public MethodType changeReturnType(Class<?> nrtype)
methodType.- Specified by:
-
changeReturnTypeв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Parameters:
-
nrtype— тип возвращаемого параметра, которым нужно заменить старый - Returns:
- тот же тип, но с изменённым типом возвращаемого значения
- Throws:
-
NullPointerException— еслиnrtypeравно null
hasPrimitives
public boolean hasPrimitives()
void считается примитивным.- Returns:
- true, если какой-либо из типов является примитивным
hasWrappers
public boolean hasWrappers()
Integer. Ссылочный тип java.lang.Void считается обёрткой, если он используется в качестве типа возвращаемого значения.- Returns:
- true, если какой-либо из типов является обёрткой
erase
public MethodType erase()
Object. Удобный метод для methodType. Все примитивные типы (включая void) останутся без изменений.- Returns:
- версия исходного типа со всеми ссылочными типами, заменёнными
generic
public MethodType generic()
Object. Удобный метод для genericMethodType. Выражение type.wrap().erase() производит то же значение, что и type.generic(). - Returns:
- версия исходного типа со всеми типами, заменёнными
wrap
public MethodType wrap()
methodType. Все ссылочные типы (включая типы-обёртки) останутся без изменений. Тип возвращаемого значения void изменяется на тип java.lang.Void. Выражение type.wrap().erase() производит то же значение, что и type.generic(). - Returns:
- версия исходного типа со всеми примитивными типами, заменёнными
unwrap
public MethodType unwrap()
methodType. Все примитивные типы (включая void) останутся без изменений. Тип возвращаемого значения java.lang.Void изменяется на void. - Returns:
- версия исходного типа со всеми типами-обёртками, заменёнными
parameterType
public Class<?> parameterType(int num)
- Specified by:
-
parameterTypeв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Parameters:
-
num— индекс (нумерация с нуля) нужного типа параметра - Returns:
- выбранный тип параметра
- Throws:
-
IndexOutOfBoundsException— еслиnumне является допустимым индексом вparameterArray()
parameterCount
public int parameterCount()
- Specified by:
-
parameterCountв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Returns:
- количество типов параметров
returnType
public Class<?> returnType()
- Specified by:
-
returnTypeв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Returns:
- тип возвращаемого значения
parameterList
public List<Class<?>> parameterList()
- Specified by:
-
parameterListв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Returns:
- типы параметров (в виде неизменяемого списка)
lastParameterType
public Class<?> lastParameterType()
void.class. - API Note:
Значение-маркер выбрано таким образом, чтобы рефлексивные запросы можно было выполнять непосредственно на результирующем значении. Значение-маркер нельзя спутать с реальным параметром, так как
voidникогда не может быть типом параметра. Для вызовов с переменным числом аргументов полезно использовать выражениеlastParameterType().getComponentType()для запроса типа параметра "varargs".- Returns:
- последний тип параметра, если он есть, иначе
void.class - Since:
- 10
parameterArray
public Class<?>[] parameterArray()
- Specified by:
-
parameterArrayв интерфейсеTypeDescriptor.OfMethod<Class<?>,MethodType> - Returns:
- типы параметров (как новая копия, если необходимо)
equals
public boolean equals(Object x)
true, если и только если указанный объект также является типом метода с точно такими же параметрами и типом возвращаемого значения.- Overrides:
-
equalsв классеObject - Parameters:
-
x— объект для сравнения - Returns:
-
trueесли этот объект такой же как и аргумент obj;falseв противном случае. - See Also:
hashCode
public int hashCode()
- Overrides:
-
hashCodeв классеObject - Returns:
- значение хэш-кода для этого типа метода
- See Also:
toString
public String toString()
"(PT0,PT1...)RT". Строковое представление типа метода — это заключённый в скобки, разделённый запятыми список имён типов, непосредственно за которым следует тип возвращаемого значения. Каждое имя типа представляется его simple name.
- Overrides:
-
toStringв классеObject - Returns:
- строковое представление объекта.
fromMethodDescriptorString
public static MethodType fromMethodDescriptorString(String descriptor, ClassLoader loader) throws IllegalArgumentException, TypeNotPresentException
methodType. Любое имя класса или интерфейса, встроенное в строку дескриптора, будет разрешено заданным загрузчиком (или, если он равен null, системным загрузчиком). Обратите внимание, что могут встречаться типы методов, которые нельзя создать этим методом, потому что все их составные типы недоступны из одного загрузчика классов.
Этот метод включён для удобства приложений, которым необходимо генерировать байткоды для работы с методами и invokedynamic.
- Parameters:
-
descriptor— строка дескриптора байткода "(T...)T" -
loader— загрузчик классов для поиска типов - Returns:
- тип метода, соответствующий строке дескриптора байткода
- Throws:
-
NullPointerException— если строка равна null -
IllegalArgumentException— если строка имеет неправильный формат -
TypeNotPresentException— если тип с заданным именем не найден -
SecurityException— если менеджер безопасности присутствует иloaderявляетсяnullи у вызывающего нет разрешенияRuntimePermission("getClassLoader")
toMethodDescriptorString
public String toMethodDescriptorString()
MethodType::descriptorString. Обратите внимание, что это не строго обратное преобразование к fromMethodDescriptorString. Два разных класса с общим именем, но с различными загрузчиками классов, будут выглядеть идентично в строках описателей.
Этот метод включён для удобства приложений, которые должны генерировать байт-код, обрабатывающий дескрипторы методов и invokedynamic. fromMethodDescriptorString, поскольку последний требует аргумента типа загрузчик классов.
- Returns:
- строку-описатель для данного типа метода
- См. Спецификацию виртуальной машины Java:
- 4.3.3 Описатели методов
- См. также:
descriptorString
public String descriptorString()
Если этот тип метода может быть описан номинально, то результатом является описатель типа метода (JVMS 4.3.3). MethodTypeDesc для этого типа метода можно получить, вызвав MethodTypeDesc::ofDescriptor со строкой-описателем в качестве аргумента.
Если этот тип метода не может быть описан номинально, и результатом является строка вида:
"(<parameter-descriptors>)<return-descriptor>" где <parameter-descriptors> — конкатенация строк-описателей всех типов параметров и типа возвращаемого значения. MethodTypeDesc не может быть создана из этой строки.- Определено в:
-
descriptorStringв интерфейсеTypeDescriptor - Returns:
- строку-описатель для этого типа метода
- См. Спецификацию виртуальной машины Java:
- 4.3.3 Описатели методов
- С:
- 12
- См. также:
describeConstable
public Optional<MethodTypeDesc> describeConstable()
Optional, если нет.- Определено в:
-
describeConstableв интерфейсеConstable - Returns:
Optionalсодержащий получившийся номинальный описатель, или пустойOptional, если он не может быть построен.- С:
- 12
- См. также:
© 1993, 2021, 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/17/docs/api/java.base/java/lang/invoke/MethodType.html