Class JavadocCommon::DocuParam

A Parameter belonging to a DocuCallable that has some Javadoc.

Direct supertypes

Indirect supertypes

Predicates

hasAcceptableParamTag

Holds if this parameter has a non-trivial @param tag.

Inherited predicates

contains

Holds if this element transitively contains the specified element e.

from Element
fromSource

Holds if this element pertains to a source file.

from Element
getAModifier

Gets a modifier of this element.

from Modifiable
getAnAccess

Gets an access to this variable.

from Variable
getAnAnnotation

Gets an annotation that applies to this element.

from Annotatable
getAnArgument

Gets an argument for this parameter in any call to the callable that declares this formal parameter.

from Parameter
getAnAssignedValue

Gets an expression on the right-hand side of an assignment to this variable.

from Variable
getCallable

Gets the callable that declares this formal parameter.

from Parameter
getCompilationUnit

Gets the compilation unit that this element belongs to.

from Element
getDoc

Cast this element to a Documentable.

from Element
getFile

Gets the file associated with this element.

from Top
getInitializer

Gets the initializer expression of this variable.

from Variable
getLocation

Gets the source location for this element.

from Top
getName

Gets the name of this element.

from Element
getNumberOfCommentLines

Gets the number of comment lines that this element ranges over.

from Top
getNumberOfLinesOfCode

Gets the number of lines of code that this element ranges over.

from Top
getPosition

Gets the (zero-based) index of this formal parameter.

from Parameter
getSourceDeclaration

Gets the source declaration of this formal parameter.

from Parameter
getTotalNumberOfLines

Gets the total number of lines that this element ranges over, including lines of code, comment and whitespace-only lines.

from Top
getType

Gets the type of this formal parameter.

from Parameter
hasAnnotation

Holds if this element has an annotation.

from Annotatable
hasAnnotation

Holds if this element has the specified annotation.

from Annotatable
hasChildElement

Holds if this element is the immediate parent of the specified element e.

from Element
hasLocationInfo

Holds if this element is at the specified location. The location spans column startcolumn of line startline to column endcolumn of line endline in file filepath. For more information, see LGTM locations.

from Top
hasModifier

Holds if this element has modifier m.

from Modifiable
hasName

Holds if this element has the specified name.

from Element
hasNoModifier

Holds if this element has no modifier.

from Modifiable
isAbstract

Holds if this element has an abstract modifier or is implicitly abstract.

from Modifiable
isDefault

Holds if this element has a default modifier.

from Modifiable
isEffectivelyFinal

Holds if the parameter is never assigned a value in the body of the callable.

from Parameter
isFinal

Holds if this element has a final modifier or is implicitly final.

from Modifiable
isNative

Holds if this element has a native modifier.

from Modifiable
isPrivate

Holds if this element has a private modifier or is implicitly private.

from Modifiable
isProtected

Holds if this element has a protected modifier.

from Modifiable
isPublic

Holds if this element has a public modifier or is implicitly public.

from Modifiable
isSourceDeclaration

Holds if this formal parameter is the same as its source declaration.

from Parameter
isStatic

Holds if this element has a static modifier or is implicitly static.

from Modifiable
isStrictfp

Holds if this element has a strictfp modifier.

from Modifiable
isSynchronized

Holds if this element has a synchronized modifier.

from Modifiable
isTransient

Holds if this element has a transient modifier.

from Modifiable
isVarargs

Holds if this formal parameter is a variable arity parameter.

from Parameter
isVolatile

Holds if this element has a volatile modifier.

from Modifiable
pp

Gets a printable representation of this variable together with its type.

from Variable
suppressesWarningsAbout

Holds if this or any enclosing Annotatable has a @SuppressWarnings("<category>") annotation attached to it for the specified category.

from Annotatable
toString

Gets a textual representation of this element.

from Top

Charpred