Spec-Zone.ru › OpenJDK 25

Класс Parameter

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()
Возвращает Executable, объявивший этот параметр.
int getModifiers()
Возвращает модификаторы языка Java для параметра, представленного этим объектом.
String getName()
Возвращает имя параметра.
Type getParameterizedType()
Возвращает объект Type, определяющий параметризованный тип параметра, представленного этим объектом Parameter.
Class<?> getType()
Возвращает объект Class, определяющий объявленный тип параметра, представленного этим объектом Parameter.
int hashCode()
Возвращает хеш-код, вычисленный на основе хеш-кода исполняемого элемента и индекса.
boolean isImplicit()
Возвращает true, если этот параметр неявно объявлен в исходном коде; в противном случае возвращает false.
boolean isNamePresent()
Возвращает true, если согласно файлу класса у параметра есть имя; в противном случае возвращает false.
boolean isSynthetic()
Возвращает true, если этот параметр не объявлен в исходном коде ни неявно, ни явно; в противном случае возвращает false.
boolean isVarArgs()
Возвращает true, если этот параметр представляет список аргументов переменной длины; в противном случае возвращает false.
String toString()
Возвращает строку с описанием этого параметра.

Методы, объявленные в классе Object

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

Методы, объявленные в интерфейсе AnnotatedElement

isAnnotationPresent

Подробное описание методов

equals

public boolean equals(Object obj)
Сравнивает на основе исполняемого элемента и индекса.
Переопределяет:
equals в классе Object
Параметры:
obj — объект для сравнения.
Возвращает:
Результат проверки равенства этого объекта аргументу.
См. также:
  • Object.hashCode()
  • HashMap

hashCode

public int hashCode()
Возвращает хеш-код, вычисленный на основе хеш-кода исполняемого элемента и индекса.
Переопределяет:
hashCode в классе Object
Возвращает:
Хеш-код, вычисленный на основе хеш-кода исполняемого элемента.
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(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 Формальные параметры
См. также:
  • Моделирование языка программирования Java и JVM в базовом API рефлексии

accessFlags

public Set<AccessFlag> accessFlags()
Возвращает неизменяемое множество флагов доступа для параметра, представленного этим объектом; множество может быть пустым.
Возвращает:
неизменяемое множество флагов доступа для параметра, представленного этим объектом; множество может быть пустым
См. Спецификацию виртуальной машины Java:
4.7.24 Атрибут MethodParameters
Начиная с:
20
См. также:
  • getModifiers()

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, представляющий использование типа для указания типа формального параметра, представленного объектом Parameter.
Возвращает:
объект AnnotatedType, представляющий использование типа для указания типа формального параметра, представленного объектом Parameter

isImplicit

public boolean isImplicit()
Возвращает true, если этот параметр неявно объявлен в исходном коде; в противном случае возвращает false.
Возвращает:
true тогда и только тогда, когда этот параметр объявлен неявно, как определено в Спецификации языка Java.

isSynthetic

public boolean isSynthetic()
Возвращает true, если этот параметр не объявлен в исходном коде ни неявно, ни явно; в противном случае возвращает false.
Возвращает:
true тогда и только тогда, когда этот параметр является синтетической конструкцией, как определено в Спецификации языка Java.
См. Спецификацию языка Java:
13.1 Форма двоичного представления
См. также:
  • Моделирование языка программирования Java и JVM в базовом API рефлексии

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, соответствующий типу аннотации
Возвращает:
все аннотации этого элемента указанного типа, связанные с элементом; в противном случае массив нулевой длины
Вызывает исключение:
NullPointerException — если указанный класс аннотации равен null

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()
Возвращает аннотации, непосредственно присутствующие у этого элемента. Этот метод игнорирует унаследованные аннотации. Если у элемента непосредственно присутствуют аннотации, возвращаемое значение — массив длины 0. Вызывающий этот метод может изменить возвращенный массив; это не повлияет на массивы, возвращаемые другим вызывающим сторонам.

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

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

getDeclaredAnnotation

public <T extends Annotation> T getDeclaredAnnotation(Class<T> annotationClass)
Возвращает аннотацию этого элемента указанного типа, если такая аннотация присутствует непосредственно; в противном случае возвращает null. Этот метод игнорирует унаследованные аннотации. (Возвращает null, если у элемента нет непосредственно присутствующих аннотаций.)

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

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

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

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

getAnnotations

public Annotation[] getAnnotations()
Возвращает аннотации, присутствующие у этого элемента. Если у элемента нет присутствующих аннотаций, возвращаемое значение — массив длины 0. Вызывающий этот метод может изменить возвращенный массив; это не повлияет на массивы, возвращаемые другим вызывающим сторонам.

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

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

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее дочерних компаний в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее дочерние компании, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/reflect/Parameter.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API