Spec-Zone.ru › OpenJDK 21

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

java.lang.Object
java.lang.reflect.Parameter
Все реализованные интерфейсы:
AnnotatedElement
public final class Parameter extends Object implements AnnotatedElement
Информация о параметрах метода. Объект java.lang.Object предоставляет информацию о параметрах метода, включая его имя и модификаторы. Он также предоставляет альтернативный способ получения атрибутов для параметра.
С тех пор:
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()
Возвращает объект 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()
Возвращает строку, описывающую этот параметр.

Методы, унаследованные от класса java.lang.Object

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

Методы, унаследованные от интерфейса java.lang.reflect.AnnotatedElement

isAnnotationPresent

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

equals

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

hashCode

public int hashCode()
Возвращает хеш-код, основанный на хеш-коде исполняемого файла и индексе.
Overrides:
hashCode в классе Object
Возвращает:
Хеш-код, основанный на хеш-коде исполняемого файла.
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

isNamePresent

public boolean isNamePresent()
Возвращает true, если параметр имеет имя согласно файлу класса; в противном случае возвращает false. Наличие имени параметра определяется атрибутом MethodParameters метода, который объявляет параметр.
Возвращает:
true, если и только если параметр имеет имя согласно файлу класса.

toString

public String toString()
Возвращает строку, описывающую этот параметр. Формат: модификаторы параметра (если есть) в каноническом порядке, как рекомендуется в Спецификации языка Java, затем полное квалифицированное имя типа параметра (исключая последний [], если параметр является переменной длины), затем "..." если параметр является переменной длины, за которым следует пробел и имя параметра.
Overrides:
toString в классе Object
Возвращает:
Строковое представление параметра и связанной информации.

getDeclaringExecutable

public Executable getDeclaringExecutable()
Возвращает Executable , объявляющий этот параметр.
Возвращает:
Executable , объявляющий этот параметр

getModifiers

public int getModifiers()
Возвращает модификаторы языка Java для параметра, представленного этим объектом.
Возвращает:
модификаторы языка Java для параметра, представленного этим объектом
См. Спецификацию языка Java:
8.4.1 Формальные параметры
См. также:
  • Моделирование языка программирования Java и JVM в ядре рефлексии

accessFlags

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

getName

public String getName()
Возвращает имя параметра. Если имя параметра присутствует (present), этот метод возвращает имя, указанное в файле класса. В противном случае этот метод синтезирует имя в формате 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 Формат двоичного файла
См. также:
  • Моделирование языка программирования Java и JVM в ядре рефлексии

isVarArgs

public boolean isVarArgs()
Возвращает true , если этот параметр представляет собой список переменной длины; в противном случае возвращает false.
Возвращает:
true если и только если этот параметр представляет собой список переменной длины.

getAnnotation

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

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

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

getAnnotationsByType

public <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)
Возвращает аннотации, связанные с этим элементом. Если аннотаций не связано с этим элементом, возвращается массив длины 0. Разница между этим методом и AnnotatedElement.getAnnotation(Class) заключается в том, что этот метод определяет, является ли аргумент типом повторяемой аннотации (JLS 9.6), и в случае положительного результата пытается найти одну или несколько аннотаций этого типа, «просматривая» контейнерную аннотацию. Вызывающая сторона этого метода может изменять возвращаемый массив; это не повлияет на массивы, возвращаемые другим вызовам.

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

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

getDeclaredAnnotations

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

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

Specified by:
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
Возвращает:
аннотации, присутствующие на этом элементе

© 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/reflect/Parameter.html

Spec-Zone.ru

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