Класс Параметр

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()`	Возвращает объект AnnotatedType, представляющий использование типа для указания типа формального параметра, представленного этим объектом Parameter.
`<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()`	Возвращает метод, объявляющий этот параметр.
`int`	`getModifiers()`	Возвращает Java-модификаторы языка для параметра, представленного этим объектом.
`String`	`getName()`	Возвращает имя параметра.
`Type`	`getParameterizedType()`	Возвращает объект, идентифицирующий параметризованный тип для параметра, представленного этим объектом.
`Class<?>`	`getType()`	Возвращает объект, идентифицирующий объявленный тип для параметра, представленного этим объектом.
`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 для параметра, представленного этим объектом.

Возвращает:

модификаторы языка Java для параметра, представленного этим объектом

См. Спецификацию языка Java:

8.4.1 Формальные параметры

См. также:

accessFlags

public Set<AccessFlag> accessFlags()

Возвращает неизменяемый набор флагов доступа для параметра, представленного этим объектом, возможно пустой.

Возвращает:

неизменяемый набор флагов доступа для параметра, представленного этим объектом, возможно пустой

См. Спецификацию виртуальной машины Java:

4.7.24 Атрибут MethodParameters

C момента:

См. также:

getName

public String getName()

Возвращает имя параметра. Если имя параметра присутствует, то этот метод возвращает имя, предоставленное файлом класса. В противном случае этот метод генерирует имя в формате argN, где N — индекс параметра в описателе метода, который объявляет параметр.

Возвращает:: Имя параметра, либо предоставленное файлом класса, либо сгенерированное, если файл класса не предоставляет имя.

getParameterizedType

public Type getParameterizedType()

Возвращает объект Type, который идентифицирует параметризованный тип для параметра, представленного этим объектом Parameter.

Возвращает:: объект Type, идентифицирующий параметризованный тип параметра, представленного этим объектом

getType

public Class<?> getType()

Возвращает объект Class, который идентифицирует объявленный тип для параметра, представленного этим объектом Parameter.

Возвращает:: объект Class, идентифицирующий объявленный тип параметра, представленного этим объектом

getAnnotatedType

public AnnotatedType getAnnotatedType()

Возвращает объект AnnotatedType, представляющий использование типа для указания типа формального параметра, представленного этим параметром.

Возвращает:: объект AnnotatedType, представляющий использование типа для указания типа формального параметра, представленного этим параметром

isImplicit

public boolean isImplicit()

Возвращает true, если этот параметр неявно объявлен в исходном коде, иначе false.

Возвращает:: true, если и только если этот параметр неявно объявлен, как определено в Спецификации языка Java.

isSynthetic

public boolean isSynthetic()

Возвращает true, если этот параметр ни явно, ни неявно объявлен в исходном коде, иначе false.

Возвращает:

true, если и только если этот параметр является синтетической конструкцией, как определено в Спецификации языка Java.

См. Спецификацию языка 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. Вызывающий метод свободен изменять возвращённый массив; это не повлияет на массивы, возвращённые другим вызывающим методам.

Обратите внимание, что любые аннотации, возвращаемые этим методом, являются аннотациями объявления.

Specified by:: getDeclaredAnnotations в интерфейсе AnnotatedElement
Возвращает:: аннотации, непосредственно присутствующие на этом элементе

getDeclaredAnnotation

public <T extends Annotation> T getDeclaredAnnotation(Class<T> annotationClass)

Возвращает аннотацию этого элемента для указанного типа, если такая аннотация непосредственно присутствует, в противном случае null. Этот метод игнорирует унаследованные аннотации. (Возвращает null, если на этом элементе нет непосредственно аннотаций).

Обратите внимание, что любая аннотация, возвращённая этим методом, является аннотацией объявления.

Specified by:: 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), и, если это так, пытается найти одну или несколько аннотаций этого типа, «просматривая» контейнерную аннотацию, если она присутствует. Вызывающий метод свободен изменять возвращённый массив; это не повлияет на массивы, возвращённые другим вызывающим методам.

Обратите внимание, что любые аннотации, возвращаемые этим методом, являются аннотациями объявления.

Specified by:: getDeclaredAnnotationsByType в интерфейсе AnnotatedElement
Параметры типа:: T - тип аннотации, для которого нужно выполнить запрос и вернуть, если она непосредственно или косвенно присутствует
Параметры:: annotationClass - объект Class, соответствующий типу аннотации
Возвращает:: все аннотации этого элемента для указанного типа аннотации, если они непосредственно или косвенно присутствуют на этом элементе, в противном случае массив длины ноль
Исключения:: NullPointerException - если указанный класс аннотации равен null

getAnnotations

public Annotation[] getAnnotations()

Возвращает аннотации, которые присутствуют на этом элементе. Если на этом элементе нет аннотаций присутствующих, значение возврата — массив длины 0. Вызывающий метод свободен изменять возвращённый массив; это не повлияет на массивы, возвращённые другим вызывающим методам.

Обратите внимание, что любые аннотации, возвращаемые этим методом, являются аннотациями объявления.

Specified by:: getAnnotations в интерфейсе AnnotatedElement
Возвращает:: аннотации, присутствующие на этом элементе

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.base/java/lang/reflect/Parameter.html