Spec-Zone.ru › OpenJDK 17

Класс Parameter

java.lang.Object
java.lang.reflect.Parameter
Все реализованные интерфейсы:
AnnotatedElement
public final class Parameter extends Object implements AnnotatedElement
Информация о параметрах метода. Объект Parameter предоставляет информацию о параметрах метода, включая его имя и модификаторы. Он также предоставляет альтернативный способ получения атрибутов для параметра.
С:
1.8

Краткое описание методов

Модификатор и тип Метод Описание
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 в ядре рефлексии

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 Форма двоичного файла
См. также:
  • Моделирование языка программирования Java и JVM в ядре рефлексии

isVarArgs

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

getAnnotation

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

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

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

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

Specified by:
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
Type Parameters:
T - тип аннотации, для которой производится запрос и которая возвращается, если она присутствует прямо или косвенно
Parameters:
annotationClass - объект класса, соответствующий типу аннотации
Returns:
все аннотации этого элемента для указанного типа аннотации, если они присутствуют на этом элементе прямо или косвенно, иначе — массив длины ноль
Throws:
NullPointerException - если указанный класс аннотации равен null

getAnnotations

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

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

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

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

Spec-Zone.ru

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