com.github.javaparser.ast.body

Class ReceiverParameter

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.body.ReceiverParameter

All Implemented Interfaces:

NodeWithAnnotations<ReceiverParameter>, NodeWithName<ReceiverParameter>, NodeWithRange<Node>, NodeWithTokenRange<Node>, NodeWithType<ReceiverParameter,Type>, Observable, Visitable, HasParentNode<Node>, Cloneable

public final class ReceiverParameter
extends Node
implements NodeWithType<ReceiverParameter,Type>, NodeWithAnnotations<ReceiverParameter>, NodeWithName<ReceiverParameter>

The rather obscure "receiver parameter" feature of Java.
All annotations preceding the type will be set on this object, not on the type. JavaParser doesn't know if it they are applicable to the receiver parameter or the type.

Author:

Julio Vilmar Gesser

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor and Description
ReceiverParameter()
ReceiverParameter(NodeList<AnnotationExpr> annotations, Type type, Name name)
ReceiverParameter(TokenRange tokenRange, NodeList<AnnotationExpr> annotations, Type type, Name name) This constructor is used by the parser and is considered private.
ReceiverParameter(Type type, Name name)
ReceiverParameter(Type type, String name) Creates a new ReceiverParameter.

Method Summary

Modifier and Type	Method and Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg) Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg) Accept method for visitor support.
ReceiverParameter	clone()
NodeList<AnnotationExpr>	getAnnotations()
ReceiverParameterMetaModel	getMetaModel()
Name	getName()
Type	getType() Gets the type
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
ReceiverParameter	setAnnotations(NodeList<AnnotationExpr> annotations)
ReceiverParameter	setName(Name name)
ReceiverParameter	setType(Type type) Sets the type

Methods inherited from class com.github.javaparser.ast.Node

addOrphanComment, containsData, customInitialization, equals, findAll, findAll, findCompilationUnit, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, hashCode, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithType

getTypeAsString, setType, setType, tryAddImportToParentCompilationUnit

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithAnnotations

addAndGetAnnotation, addAndGetAnnotation, addAnnotation, addAnnotation, addAnnotation, addMarkerAnnotation, addMarkerAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, addSingleMemberAnnotation, getAnnotation, getAnnotationByClass, getAnnotationByName, isAnnotationPresent, isAnnotationPresent, setAnnotation, tryAddImportToParentCompilationUnit

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithName

getNameAsString, setName

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange

containsWithin, getBegin, getEnd

Constructor Detail

ReceiverParameter

public ReceiverParameter()

ReceiverParameter

public ReceiverParameter(Type type,
                         Name name)

ReceiverParameter

public ReceiverParameter(Type type,
                         String name)

Creates a new ReceiverParameter.

Parameters:

type - type of the parameter

name - name of the parameter

ReceiverParameter

public ReceiverParameter(NodeList<AnnotationExpr> annotations,
                         Type type,
                         Name name)

ReceiverParameter

public ReceiverParameter(TokenRange tokenRange,
                         NodeList<AnnotationExpr> annotations,
                         Type type,
                         Name name)

This constructor is used by the parser and is considered private.

Method Detail

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                      A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

getType

public Type getType()

Description copied from interface: NodeWithType

Gets the type

Specified by:

getType in interface NodeWithType<ReceiverParameter,Type>

Returns:

the type

setType

public ReceiverParameter setType(Type type)

Description copied from interface: NodeWithType

Sets the type

Specified by:

setType in interface NodeWithType<ReceiverParameter,Type>

Parameters:

type - the type

Returns:

this

getAnnotations

public NodeList<AnnotationExpr> getAnnotations()

Specified by:

getAnnotations in interface NodeWithAnnotations<ReceiverParameter>

Returns:

the list returned could be immutable (in that case it will be empty)

setAnnotations

public ReceiverParameter setAnnotations(NodeList<AnnotationExpr> annotations)

Specified by:

setAnnotations in interface NodeWithAnnotations<ReceiverParameter>

Parameters:

annotations - a null value is currently treated as an empty list. This behavior could change in the future, so please avoid passing null

clone

public ReceiverParameter clone()

Overrides:

clone in class Node

getMetaModel

public ReceiverParameterMetaModel getMetaModel()

Overrides:

getMetaModel in class Node

Returns:

get JavaParser specific node introspection information.

getName

public Name getName()

Specified by:

getName in interface NodeWithName<ReceiverParameter>

setName

public ReceiverParameter setName(Name name)

Specified by:

setName in interface NodeWithName<ReceiverParameter>

remove

public boolean remove(Node node)

Overrides:

remove in class Node

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Node