Класс Метод

Объект Method предоставляет информацию о и доступ к одному методу класса или интерфейса. Отражённый метод может быть классовым или экземпляром метода (включая абстрактный метод).

Объект Method разрешает расширяющие преобразования при сопоставлении фактических параметров вызова с формальными параметрами базового метода, но он выбрасывает исключение IllegalArgumentException, если произойдёт сужающее преобразование.

Методы

getDeclaringClass

public Class<?> getDeclaringClass()

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

Определено в:

getDeclaringClass в интерфейсе Member

Определено в:

getDeclaringClass в классе Executable

Возвращает:

объект, представляющий класс, объявляющий базовый член

getName

public String getName()

Возвращает имя метода, представленного этим объектом Method, в виде String.

Определено в:

getName в интерфейсе Member

Определено в:

getName в классе Executable

Возвращает:

простое имя базового члена

getModifiers

public int getModifiers()

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

Определено в:

getModifiers в интерфейсе Member

Определено в:

getModifiers в классе Executable

Возвращает:

модификаторы языка Java для базового члена

См. также:

Modifier

getTypeParameters

public TypeVariable<Method>[] getTypeParameters()

Возвращает массив объектов TypeVariable, представляющих переменные типов, объявленные обобщенным объявлением, представленным этим объектом GenericDeclaration, в порядке объявления. Возвращает массив длины 0, если базовый обобщенный декларатор не объявляет переменных типов.

Определено в:

getTypeParameters в интерфейсе GenericDeclaration

Определено в:

getTypeParameters в классе Executable

Возвращает:

массив объектов TypeVariable, представляющих переменные типов, объявленные этим обобщенным объявлением

Исключения:

GenericSignatureFormatError - если обобщенная сигнатура этого обобщенного объявления не соответствует формату, указанному в Спецификации Java™ Virtual Machine

С момента:

1.5

getReturnType

public Class<?> getReturnType()

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

Возвращает:

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

getGenericReturnType

public Type getGenericReturnType()

Возвращает:

объект Type, представляющий формальный тип возвращаемого значения базового метода

Исключения:

GenericSignatureFormatError - если обобщенная сигнатура метода не соответствует формату, указанному в Спецификации Java™ Virtual Machine

TypeNotPresentException - если тип возвращаемого значения базового метода ссылается на необъявленный тип

MalformedParameterizedTypeException - если тип возвращаемого значения базового метода ссылается на параметризованный тип, который нельзя создать по какой-либо причине

С момента:

1.5

getParameterTypes

public Class<?>[] getParameterTypes()

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

Определено в:

getParameterTypes в классе Executable

Возвращает:

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

getParameterCount

public int getParameterCount()

Возвращает количество формальных параметров (явно объявленных, неявно объявленных или ни тех, ни других) для исполняемого кода, представленного этим объектом.

Переопределяет:

getParameterCount в классе Executable

Возвращает:

Количество формальных параметров для исполняемого кода, представленного этим объектом

С момента:

1.8

getGenericParameterTypes

public Type[] getGenericParameterTypes()

Переопределяет:

getGenericParameterTypes в классе Executable

Возвращает:

массив Type, представляющих формальные типы параметров базового исполняемого кода в порядке объявления

Исключения:

GenericSignatureFormatError - если обобщенная сигнатура метода не соответствует формату, указанному в Спецификации Java™ Virtual Machine

TypeNotPresentException - если любой из типов параметров базового исполняемого кода ссылается на необъявленный тип

MalformedParameterizedTypeException - если любой из типов параметров базового исполняемого кода ссылается на параметризованный тип, который нельзя создать по какой-либо причине

С момента:

1.5

getExceptionTypes

public Class<?>[] getExceptionTypes()

Возвращает массив объектов Class, представляющих типы исключений, объявленных для бросания базовым исполняемым кодом, представленным этим объектом. Возвращает массив длиной 0, если исполняемый код не объявляет исключений в своем блоке throws.

Определено в:

getExceptionTypes в классе Executable

Возвращает:

типы исключений, объявленные для бросания исполняемым кодом, представленным этим объектом

getGenericExceptionTypes

public Type[] getGenericExceptionTypes()

Переопределяет:

getGenericExceptionTypes в классе Executable

Возвращает:

массив типов, представляющих типы исключений, брошенных базовым исполняемым кодом

Исключения:

GenericSignatureFormatError - если обобщенная сигнатура метода не соответствует формату, указанному в Спецификации Java™ Virtual Machine

TypeNotPresentException - если блок throws базового исполняемого кода ссылается на необъявленный тип

MalformedParameterizedTypeException - если блок throws базового исполняемого кода ссылается на параметризованный тип, который нельзя создать по какой-либо причине

С момента:

1.5

equals

public boolean equals(Object obj)

Сравнивает этот объект Method с указанным объектом. Возвращает true, если объекты совпадают. Два объекта Methods совпадают, если они были объявлены одним и тем же классом и имеют одинаковое имя, типы формальных параметров и тип возвращаемого значения.

Переопределяет:

equals в классе Object

Параметры:

obj - ссылка на объект для сравнения.

Возвращает:

true если этот объект совпадает с аргументом obj; false в противном случае.

См. также:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Возвращает хэш-код для этого объекта Method. Хэш-код вычисляется как исключающее ИЛИ хэш-кодов имени объявляющего класса базового метода и имени метода.

Переопределяет:

hashCode в классе Object

Возвращает:

значение хэш-кода для этого объекта.

См. также:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

public boolean java.lang.Object.equals(java.lang.Object)

Переопределяет:

toString в классе Object

Возвращает:

строку, описывающую этот объект Method

toGenericString

public String toGenericString()

Указано в:

toGenericString в классе Executable

Возвращает:

строку, описывающую этот Method, включая параметры типа

С тех пор, как:

1.5

invoke

public Object invoke(Object obj,
                     Object... args)
              throws IllegalAccessException,
                     IllegalArgumentException,
                     InvocationTargetException

Параметры:

obj - объект, из которого вызывается базовый метод

args - аргументы, используемые для вызова метода

Возвращает:

результат диспетчеризации метода, представленного этим объектом, в obj с параметрами args

Выбрасывает:

IllegalAccessException - если этот объект Method проверяет контроль доступа языка Java, и базовый метод недоступен.

IllegalArgumentException - если метод является методом экземпляра, и указанный аргумент объекта не является экземпляром класса или интерфейса, объявляющего базовый метод (или подкласса или реализующего интерфейс); если количество фактических и формальных параметров отличается; если преобразование распаковки для примитивных аргументов не удаётся; или если после возможной распаковки значение параметра не может быть преобразовано в соответствующий формальный тип параметра с помощью преобразования вызова метода.

InvocationTargetException - если базовый метод выбрасывает исключение.

NullPointerException - если указанный объект равен null, и метод является методом экземпляра.

ExceptionInInitializerError - если инициализация, вызванная этим методом, не удалась.

isBridge

public boolean isBridge()

Возвращает true, если этот метод является методом моста; в противном случае возвращает false.

Возвращает:

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

С тех пор, как:

1.5

isVarArgs

public boolean isVarArgs()

Возвращает true, если этот исполняемый элемент был объявлен с переменным числом аргументов; в противном случае возвращает false.

Переопределяет:

isVarArgs в классе Executable

Возвращает:

true, если и только если этот исполняемый элемент был объявлен с переменным числом аргументов.

С тех пор, как:

1.5

isSynthetic

public boolean isSynthetic()

Возвращает true, если этот исполняемый элемент является синтетической конструкцией; в противном случае возвращает false.

Указано в:

isSynthetic в интерфейсе Member

Переопределяет:

isSynthetic в классе Executable

Возвращает:

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

С тех пор, как:

1.5

isDefault

public boolean isDefault()

Возвращает true, если этот метод является методом по умолчанию; в противном случае возвращает false. Метод по умолчанию — это публичный неабстрактный метод экземпляра, то есть метод без модификатора static с телом, объявленный в типе интерфейса.

Возвращает:

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

С тех пор, как:

1.8

getDefaultValue

public Object getDefaultValue()

Возвращает значение по умолчанию для члена аннотации, представленного этим экземпляром Method. Если член имеет примитивный тип, возвращается экземпляр соответствующего типа обёртки. Возвращает null, если члену не назначено значение по умолчанию или если экземпляр метода не представляет объявленного члена типа аннотации.

Возвращает:

значение по умолчанию для члена аннотации, представленного этим экземпляром Method.

Выбрасывает:

TypeNotPresentException - если аннотация имеет тип Class и определение значения по умолчанию для класса не найдено.

С тех пор, как:

1.5

getAnnotation

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

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

Указано в:

getAnnotation в интерфейсе AnnotatedElement

Переопределяет:

getAnnotation в классе Executable

Параметры типа:

T - тип аннотации, для которой выполняется запрос и возвращается, если она присутствует

Параметры:

annotationClass - объект Class, соответствующий типу аннотации

Возвращает:

аннотация элемента для указанного типа аннотации, если она присутствует в этом элементе, в противном случае null

Выбрасывает:

NullPointerException - если заданный класс аннотации равен null

С тех пор, как:

1.5

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()

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

Указано в:

getDeclaredAnnotations в интерфейсе AnnotatedElement

Переопределяет:

getDeclaredAnnotations в классе Executable

Возвращает:

аннотации, непосредственно присутствующие в этом элементе

С тех пор, как:

1.5

getParameterAnnotations

public Annotation[][] getParameterAnnotations()

Возвращает массив массивов Annotation, представляющих аннотации формальных параметров, в порядке объявления, метода Executable, представленного этим объектом. Синтетические и требуемые параметры (см. объяснение ниже), такие как внешний параметр "this" конструктора внутреннего класса, будут представлены в возвращаемом массиве. Если исполняемый элемент не имеет параметров (то есть ни формальных, ни синтетических, ни требуемых), возвращается массив нулевой длины. Если у Executable есть один или несколько параметров, для каждого параметра без аннотаций возвращается вложенный массив длины ноль. Объекты аннотаций, содержащиеся в возвращаемых массивах, сериализуемы. Вызывающая сторона этого метода свободна изменять возвращаемые массивы; это не повлияет на массивы, возвращаемые другими вызывающими сторонами. Компилятор может добавлять дополнительные параметры, неявно объявленные в исходном коде ("требуемые"), а также параметры, которые не являются ни неявно, ни явно объявленными в исходном коде ("синтетические"), в список параметров для метода. См. Parameter для получения дополнительной информации.

Указано в:

getParameterAnnotations в классе Executable

Возвращает:

массив массивов, представляющих аннотации формальных и неявных параметров, в порядке объявления, исполняемого элемента, представленного этим объектом

С тех пор, как:

1.5

См. также:

Parameter, Parameter.getAnnotations()

getAnnotatedReturnType

public AnnotatedType getAnnotatedReturnType()

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

Указано в:

getAnnotatedReturnType в классе Executable

Возвращает:

объект, представляющий тип возвращаемого значения метода или конструктора, представленного этим Executable

С тех пор, как:

1.8