Liking cljdoc? Tell your friends :D

jdk.lang.reflect.Parameter

Information about method parameters.

A Parameter provides information about method parameters, including its name and modifiers. It also provides an alternate means of obtaining attributes for the parameter.

Information about method parameters.

A Parameter provides information about method parameters,
including its name and modifiers.  It also provides an alternate
means of obtaining attributes for the parameter.
raw docstring

equalsclj

(equals this obj)

Compares based on the executable and the index.

obj - The object to compare. - java.lang.Object

returns: Whether or not this is equal to the argument. - boolean

Compares based on the executable and the index.

obj - The object to compare. - `java.lang.Object`

returns: Whether or not this is equal to the argument. - `boolean`
raw docstring

get-annotated-typeclj

(get-annotated-type this)

Returns an AnnotatedType object that represents the use of a type to specify the type of the formal parameter represented by this Parameter.

returns: an AnnotatedType object representing the use of a type to specify the type of the formal parameter represented by this Parameter - java.lang.reflect.AnnotatedType

Returns an AnnotatedType object that represents the use of a type to
 specify the type of the formal parameter represented by this Parameter.

returns: an AnnotatedType object representing the use of a type
         to specify the type of the formal parameter represented by this
         Parameter - `java.lang.reflect.AnnotatedType`
raw docstring

get-annotationclj

(get-annotation this annotation-class)

Returns this element's annotation for the specified type if such an annotation is present, else null.

annotation-class - the Class object corresponding to the annotation type - java.lang.Class

returns: this element's annotation for the specified annotation type if present on this element, else null - <T extends java.lang.annotation.Annotation> T

throws: java.lang.NullPointerException - if the given annotation class is null

Returns this element's annotation for the specified type if
 such an annotation is present, else null.

annotation-class - the Class object corresponding to the annotation type - `java.lang.Class`

returns: this element's annotation for the specified annotation type if
     present on this element, else null - `<T extends java.lang.annotation.Annotation> T`

throws: java.lang.NullPointerException - if the given annotation class is null
raw docstring

get-annotationsclj

(get-annotations this)

Returns annotations that are present on this element.

If there are no annotations present on this element, the return value is an array of length 0.

The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

returns: annotations present on this element - java.lang.annotation.Annotation[]

Returns annotations that are present on this element.

 If there are no annotations present on this element, the return
 value is an array of length 0.

 The caller of this method is free to modify the returned array; it will
 have no effect on the arrays returned to other callers.

returns: annotations present on this element - `java.lang.annotation.Annotation[]`
raw docstring

get-annotations-by-typeclj

(get-annotations-by-type this annotation-class)

Returns annotations that are associated with this element.

If there are no annotations associated with this element, the return value is an array of length 0.

The difference between this method and AnnotatedElement.getAnnotation(Class) is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation.

The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

annotation-class - the Class object corresponding to the annotation type - java.lang.Class

returns: all this element's annotations for the specified annotation type if associated with this element, else an array of length zero - <T extends java.lang.annotation.Annotation> T[]

throws: java.lang.NullPointerException - if the given annotation class is null

Returns annotations that are associated with this element.

 If there are no annotations associated with this element, the return
 value is an array of length 0.

 The difference between this method and AnnotatedElement.getAnnotation(Class)
 is that this method detects if its argument is a repeatable
 annotation type (JLS 9.6), and if so, attempts to find one or
 more annotations of that type by "looking through" a container
 annotation.

 The caller of this method is free to modify the returned array; it will
 have no effect on the arrays returned to other callers.

annotation-class - the Class object corresponding to the annotation type - `java.lang.Class`

returns: all this element's annotations for the specified annotation type if
     associated with this element, else an array of length zero - `<T extends java.lang.annotation.Annotation> T[]`

throws: java.lang.NullPointerException - if the given annotation class is null
raw docstring

get-declared-annotationclj

(get-declared-annotation this annotation-class)

Description copied from interface: AnnotatedElement

annotation-class - the Class object corresponding to the annotation type - java.lang.Class

returns: this element's annotation for the specified annotation type if directly present on this element, else null - <T extends java.lang.annotation.Annotation> T

throws: java.lang.NullPointerException - if the given annotation class is null

Description copied from interface: AnnotatedElement

annotation-class - the Class object corresponding to the annotation type - `java.lang.Class`

returns: this element's annotation for the specified annotation type if
     directly present on this element, else null - `<T extends java.lang.annotation.Annotation> T`

throws: java.lang.NullPointerException - if the given annotation class is null
raw docstring

get-declared-annotationsclj

(get-declared-annotations this)

Returns annotations that are directly present on this element. This method ignores inherited annotations.

If there are no annotations directly present on this element, the return value is an array of length 0.

The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

returns: annotations directly present on this element - java.lang.annotation.Annotation[]

Returns annotations that are directly present on this element.
 This method ignores inherited annotations.

 If there are no annotations directly present on this element,
 the return value is an array of length 0.

 The caller of this method is free to modify the returned array; it will
 have no effect on the arrays returned to other callers.

returns: annotations directly present on this element - `java.lang.annotation.Annotation[]`
raw docstring

get-declared-annotations-by-typeclj

(get-declared-annotations-by-type this annotation-class)

Description copied from interface: AnnotatedElement

annotation-class - the Class object corresponding to the annotation type - java.lang.Class

returns: all this element's annotations for the specified annotation type if directly or indirectly present on this element, else an array of length zero - <T extends java.lang.annotation.Annotation> T[]

throws: java.lang.NullPointerException - if the given annotation class is null

Description copied from interface: AnnotatedElement

annotation-class - the Class object corresponding to the annotation type - `java.lang.Class`

returns: all this element's annotations for the specified annotation type if
     directly or indirectly present on this element, else an array of length zero - `<T extends java.lang.annotation.Annotation> T[]`

throws: java.lang.NullPointerException - if the given annotation class is null
raw docstring

get-declaring-executableclj

(get-declaring-executable this)

Return the Executable which declares this parameter.

returns: The Executable declaring this parameter. - java.lang.reflect.Executable

Return the Executable which declares this parameter.

returns: The Executable declaring this parameter. - `java.lang.reflect.Executable`
raw docstring

get-modifiersclj

(get-modifiers this)

Get the modifier flags for this the parameter represented by this Parameter object.

returns: The modifier flags for this parameter. - int

Get the modifier flags for this the parameter represented by
 this Parameter object.

returns: The modifier flags for this parameter. - `int`
raw docstring

get-nameclj

(get-name this)

Returns the name of the parameter. If the parameter's name is present, then this method returns the name provided by the class file. Otherwise, this method synthesizes a name of the form argN, where N is the index of the parameter in the descriptor of the method which declares the parameter.

returns: The name of the parameter, either provided by the class file or synthesized if the class file does not provide a name. - java.lang.String

Returns the name of the parameter.  If the parameter's name is
 present, then this method returns
 the name provided by the class file. Otherwise, this method
 synthesizes a name of the form argN, where N is the index of
 the parameter in the descriptor of the method which declares
 the parameter.

returns: The name of the parameter, either provided by the class
         file or synthesized if the class file does not provide
         a name. - `java.lang.String`
raw docstring

get-parameterized-typeclj

(get-parameterized-type this)

Returns a Type object that identifies the parameterized type for the parameter represented by this Parameter object.

returns: a Type object identifying the parameterized type of the parameter represented by this object - java.lang.reflect.Type

Returns a Type object that identifies the parameterized
 type for the parameter represented by this Parameter
 object.

returns: a Type object identifying the parameterized
 type of the parameter represented by this object - `java.lang.reflect.Type`
raw docstring

get-typeclj

(get-type this)

Returns a Class object that identifies the declared type for the parameter represented by this Parameter object.

returns: a Class object identifying the declared type of the parameter represented by this object - java.lang.Class<?>

Returns a Class object that identifies the
 declared type for the parameter represented by this
 Parameter object.

returns: a Class object identifying the declared
 type of the parameter represented by this object - `java.lang.Class<?>`
raw docstring

hash-codeclj

(hash-code this)

Returns a hash code based on the executable's hash code and the index.

returns: A hash code based on the executable's hash code. - int

Returns a hash code based on the executable's hash code and the
 index.

returns: A hash code based on the executable's hash code. - `int`
raw docstring

implicit?clj

(implicit? this)

Returns true if this parameter is implicitly declared in source code; returns false otherwise.

returns: true if and only if this parameter is implicitly declared as defined by The Java™ Language Specification. - boolean

Returns true if this parameter is implicitly declared
 in source code; returns false otherwise.

returns: true if and only if this parameter is implicitly
 declared as defined by The Java™ Language
 Specification. - `boolean`
raw docstring

name-present?clj

(name-present? this)

Returns true if the parameter has a name according to the class file; returns false otherwise. Whether a parameter has a name is determined by the MethodParameters attribute of the method which declares the parameter.

returns: true if and only if the parameter has a name according to the class file. - boolean

Returns true if the parameter has a name according to the class
 file; returns false otherwise. Whether a parameter has a name
 is determined by the MethodParameters attribute of
 the method which declares the parameter.

returns: true if and only if the parameter has a name according
 to the class file. - `boolean`
raw docstring

synthetic?clj

(synthetic? this)

Returns true if this parameter is neither implicitly nor explicitly declared in source code; returns false otherwise.

returns: true if and only if this parameter is a synthetic construct as defined by The Java™ Language Specification. - boolean

Returns true if this parameter is neither implicitly
 nor explicitly declared in source code; returns false
 otherwise.

returns: true if and only if this parameter is a synthetic
 construct as defined by
 The Java™ Language Specification. - `boolean`
raw docstring

to-stringclj

(to-string this)

Returns a string describing this parameter. The format is the modifiers for the parameter, if any, in canonical order as recommended by The Java™ Language Specification, followed by the fully- qualified type of the parameter (excluding the last [] if the parameter is variable arity), followed by "..." if the parameter is variable arity, followed by a space, followed by the name of the parameter.

returns: A string representation of the parameter and associated information. - java.lang.String

Returns a string describing this parameter.  The format is the
 modifiers for the parameter, if any, in canonical order as
 recommended by The Java™ Language
 Specification, followed by the fully- qualified type of
 the parameter (excluding the last [] if the parameter is
 variable arity), followed by "..." if the parameter is variable
 arity, followed by a space, followed by the name of the
 parameter.

returns: A string representation of the parameter and associated
 information. - `java.lang.String`
raw docstring

var-args?clj

(var-args? this)

Returns true if this parameter represents a variable argument list; returns false otherwise.

returns: true if an only if this parameter represents a variable argument list. - boolean

Returns true if this parameter represents a variable
 argument list; returns false otherwise.

returns: true if an only if this parameter represents a
 variable argument list. - `boolean`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close