Package net.sourceforge.pmd.lang.kotlin.ast

Class AttributeView<T extends KotlinNode>

java.lang.Object

net.sourceforge.pmd.lang.kotlin.ast.AttributeView<T>

Type Parameters:

T - the corresponding ANTLR node

All Implemented Interfaces:

Node, Reportable

Direct Known Subclasses:

KtClassDeclarationAttributes, KtClassParameterAttributes, KtCompanionObjectAttributes, KtFunctionDeclarationAttributes, KtImportAliasAttributes, KtImportHeaderAttributes, KtVariableDeclarationAttributes

@Experimental
public abstract class AttributeView<T extends KotlinNode>
extends Object
implements Node

Base class for companion classes that allow to define additional attributes on KotlinNodes generated by ANTLR.

The concrete subclasses are returned by KotlinInnerNode.attributes(Class) for usage in Java-based rules. The attributes defined in the subclasses are automatically available as XPath-Attributes.

Additionally, common attributes for multiple types can be defined as interfaces, e.g. HasModifiers and HasSimpleIdentifier.

Experimental Status:

For Kotlin only, might be moved to pmd-core, if it proves useful

Since:

7.25.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	node

Fields inherited from interface net.sourceforge.pmd.lang.ast.Node

COORDS_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
AttributeView(T node)

Method Summary

Modifier and Type	Method	Description
<P, R> R	acceptVisitor(AstVisitor<? super P,? extends R> visitor, P data)
NodeStream<KotlinNode>	ancestors()
<R extends Node> NodeStream<R>	ancestors(Class<? extends R> rClass)
NodeStream<KotlinNode>	ancestorsOrSelf()
NodeStream<KotlinNode>	asStream()
NodeStream<KotlinNode>	children()
<R extends Node> NodeStream<R>	children(Class<? extends R> rClass)
int	compareLocation(Node other)
static @Nullable AttributeView<?>	create(KotlinNode kotlinNode)
NodeStream.DescendantNodeStream<KotlinNode>	descendants()
<R extends Node> NodeStream.DescendantNodeStream<R>	descendants(Class<? extends R> rClass)
NodeStream.DescendantNodeStream<KotlinNode>	descendantsOrSelf()
<R extends Node> R	firstChild(Class<? extends R> rClass)
AstInfo<? extends RootNode>	getAstInfo()
int	getBeginColumn()
int	getBeginLine()
KotlinNode	getChild(int index)
int	getEndColumn()
int	getEndLine()
@Nullable KotlinNode	getFirstChild()
String	getImage()	Deprecated. Since 7.25.0.
int	getIndexInParent()
LanguageVersion	getLanguageVersion()
@Nullable KotlinNode	getLastChild()
@Nullable KotlinNode	getNextSibling()
final T	getNode()
int	getNumChildren()
KotlinNode	getParent()
@Nullable KotlinNode	getPreviousSibling()
FileLocation	getReportLocation()
@NonNull RootNode	getRoot()
@NonNull TextDocument	getTextDocument()
TextRegion	getTextRegion()
DataMap<DataMap.DataKey<?,?>>	getUserMap()
String	getXPathNodeName()
boolean	hasImageEqualTo(String image)	Deprecated. Since 7.25.0.
boolean	isFindBoundary()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

getXPathAttributesIterator

Field Details

node

protected final T extends KotlinNode node

Constructor Details

AttributeView

public AttributeView(T node)

Method Details

getNode

public final T getNode()

create

@Experimental
public static @Nullable AttributeView<?> create(KotlinNode kotlinNode)

getChild

public KotlinNode getChild(int index)

Specified by:

getChild in interface Node

hasImageEqualTo

@Deprecated
public boolean hasImageEqualTo(String image)

Deprecated.

Since 7.25.0. Don't use getImage() or hasImageEqualTo()! See #4787.

Specified by:

hasImageEqualTo in interface Node

getImage

@NoAttribute
@Deprecated
public String getImage()

Deprecated.

Since 7.25.0. Don't use getImage() or hasImageEqualTo()! See #4787.

Specified by:

getImage in interface Node

getRoot

public @NonNull RootNode getRoot()

Specified by:

getRoot in interface Node

getLanguageVersion

public LanguageVersion getLanguageVersion()

Specified by:

getLanguageVersion in interface Node

compareLocation

public int compareLocation(Node other)

Specified by:

compareLocation in interface Node

getReportLocation

public FileLocation getReportLocation()

Specified by:

getReportLocation in interface Node

Specified by:

getReportLocation in interface Reportable

getIndexInParent

public int getIndexInParent()

Specified by:

getIndexInParent in interface Node

ancestors

public <R extends Node> NodeStream<R> ancestors(Class<? extends R> rClass)

Specified by:

ancestors in interface Node

acceptVisitor

public <P,
R> R acceptVisitor(AstVisitor<? super P,? extends R> visitor,
 P data)

Specified by:

acceptVisitor in interface Node

getTextDocument

public @NonNull TextDocument getTextDocument()

Specified by:

getTextDocument in interface Node

getTextRegion

public TextRegion getTextRegion()

Specified by:

getTextRegion in interface Node

children

public <R extends Node> NodeStream<R> children(Class<? extends R> rClass)

Specified by:

children in interface Node

getAstInfo

public AstInfo<? extends RootNode> getAstInfo()

Specified by:

getAstInfo in interface Node

descendants

public <R extends Node>
NodeStream.DescendantNodeStream<R> descendants(Class<? extends R> rClass)

Specified by:

descendants in interface Node

getBeginLine

public int getBeginLine()

Specified by:

getBeginLine in interface Node

isFindBoundary

@NoAttribute
public boolean isFindBoundary()

Specified by:

isFindBoundary in interface Node

firstChild

public <R extends Node> R firstChild(Class<? extends R> rClass)

Specified by:

firstChild in interface Node

getBeginColumn

public int getBeginColumn()

Specified by:

getBeginColumn in interface Node

getXPathNodeName

public String getXPathNodeName()

Specified by:

getXPathNodeName in interface Node

getEndLine

public int getEndLine()

Specified by:

getEndLine in interface Node

getEndColumn

public int getEndColumn()

Specified by:

getEndColumn in interface Node

getNumChildren

public int getNumChildren()

Specified by:

getNumChildren in interface Node

getUserMap

public DataMap<DataMap.DataKey<?,?>> getUserMap()

Specified by:

getUserMap in interface Node

getFirstChild

public @Nullable KotlinNode getFirstChild()

Specified by:

getFirstChild in interface Node

getParent

public KotlinNode getParent()

Specified by:

getParent in interface Node

getNextSibling

public @Nullable KotlinNode getNextSibling()

Specified by:

getNextSibling in interface Node

getLastChild

public @Nullable KotlinNode getLastChild()

Specified by:

getLastChild in interface Node

asStream

public NodeStream<KotlinNode> asStream()

Specified by:

asStream in interface Node

children

public NodeStream<KotlinNode> children()

Specified by:

children in interface Node

descendants

public NodeStream.DescendantNodeStream<KotlinNode> descendants()

Specified by:

descendants in interface Node

descendantsOrSelf

public NodeStream.DescendantNodeStream<KotlinNode> descendantsOrSelf()

Specified by:

descendantsOrSelf in interface Node

ancestorsOrSelf

public NodeStream<KotlinNode> ancestorsOrSelf()

Specified by:

ancestorsOrSelf in interface Node

ancestors

public NodeStream<KotlinNode> ancestors()

Specified by:

ancestors in interface Node

getPreviousSibling

public @Nullable KotlinNode getPreviousSibling()

Specified by:

getPreviousSibling in interface Node