jmlparser-core/com.github.javaparser.ast.expr/Name

Name

open class Name : Node, NodeWithIdentifier<Name> (source)

A name that may consist of multiple identifiers. In other words: it.may.contain.dots.

The rightmost identifier is "identifier", The one to the left of it is "qualifier.identifier", etc.

You can construct one from a String with the parseName method.

Author

Julio Vilmar Gesser

Constructors

Name

constructor()

constructor(identifier: String)

constructor(qualifier: Name, identifier: String)

constructor(tokenRange: TokenRange, qualifier: Name, identifier: String)

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

Properties

ABSOLUTE_BEGIN_LINE

val ~~ABSOLUTE_BEGIN_LINE~~: Int = -1

ABSOLUTE_END_LINE

val ~~ABSOLUTE_END_LINE~~: Int = -2

identifier

open var identifier: String

LINE_SEPARATOR_KEY

val LINE_SEPARATOR_KEY: DataKey<LineSeparator>

NODE_BY_BEGIN_POSITION

open var NODE_BY_BEGIN_POSITION: Comparator<NodeWithRange<out Any>>

This can be used to sort nodes on position.

parentNode

private open var parentNode: Node

parsed

open var parsed: Node.Parsedness

PRINTER_KEY

val PRINTER_KEY: DataKey<Printer>

range

private open var range: Range

SYMBOL_RESOLVER_KEY

val SYMBOL_RESOLVER_KEY: DataKey<SymbolResolver>

tokenRange

private open var tokenRange: TokenRange

Functions

open fun <R, A> accept(v: GenericVisitor<R, A>, arg: A): R

open fun <A> accept(v: VoidVisitor<A>, arg: A)

Accept method for visitor support.

addOrphanComment

open fun addOrphanComment(comment: Comment)

associatedSpecificationComments

@Nullable

open fun associatedSpecificationComments(): @Nullable NodeList<Comment>

asString

open fun asString(): String

clone

open fun clone(): Name

comment

@Nullable

open fun comment(): @Nullable Comment

containsData

open fun containsData(key: DataKey<out Any>): Boolean

containsWithin

open fun ~~containsWithin~~(other: Node): Boolean

containsWithinRange

open fun containsWithinRange(other: Node): Boolean

Checks whether the range of the given Node is contained within the range of this NodeWithRange.

equals

open fun equals(obj: Any): Boolean

findAll

open fun <T : Node?> findAll(nodeType: Class<T>): List<T>

Walks the AST with pre-order traversal, returning all nodes of type "nodeType".

open fun <T : Node?> findAll(nodeType: Class<T>, traversal: Node.TreeTraversal): List<T>

Walks the AST with specified traversal order, returning all nodes of type "nodeType".

open fun <T : Node?> findAll(nodeType: Class<T>, predicate: Predicate<T>): List<T>

Walks the AST with pre-order traversal, returning all nodes of type "nodeType" that match the predicate.

findAncestor

open fun <N> findAncestor(types: Array<Class<N>>): Optional<N>

Walks the parents of this node and returns the first node of type type, or empty() if none is found.

open fun <N> ~~findAncestor~~(type: Class<N>, predicate: Predicate<N>): Optional<N>

Walks the parents of this node and returns the first node of type type that matches predicate, or empty() if none is found.

open fun <N> findAncestor(predicate: Predicate<N>, types: Array<Class<N>>): Optional<N>

Walks the parents of this node and returns the first node that matches one of types types, or empty() if none is found.

findByRange

open fun findByRange(range: Range): Optional<Node>

findCompilationUnit

open fun findCompilationUnit(): Optional<CompilationUnit>

findData

open fun <M> findData(key: DataKey<M>): Optional<M>

Gets data for this node using the given key or returns an Optional.empty().

findFirst

open fun <N : Node?> findFirst(nodeType: Class<N>): Optional<N>

Walks the AST with pre-order traversal, returning the first node of type "nodeType" or empty() if none is found.

open fun <T> findFirst(traversal: Node.TreeTraversal, consumer: (Node) -> Optional<T>): Optional<T>

Walks the AST, applying the function for every node, with traversal algorithm "traversal".

open fun <N : Node?> findFirst(nodeType: Class<N>, predicate: Predicate<N>): Optional<N>

Walks the AST with pre-order traversal, returning the first node of type "nodeType" that matches "predicate" or empty() if none is found.

findRootNode

open fun findRootNode(): Node

Finds the root node of this AST by finding the topmost parent.

getAllContainedComments

open fun getAllContainedComments(): List<Comment>

This is the list of Comment which are contained in the Node either because they are properly associated to one of its children or because they are floating around inside the Node

getAssociatedSpecificationComments

open fun getAssociatedSpecificationComments(): Optional<NodeList<Comment>>

This field is used by key to associated (JML) comments to this node.

getBegin

open fun getBegin(): Optional<Position>

The begin position of this node in the source file.

getChildNodes

open fun getChildNodes(): List<Node>

Contains all nodes that have this node set as their parent.

getChildNodesByType

open fun <N : Node?> ~~getChildNodesByType~~(clazz: Class<N>): List<N>

Recursively finds all nodes of a certain type.

getComment

open fun getComment(): Optional<Comment>

This is a comment associated with this node.

getData

open fun <M> getData(key: DataKey<M>): M

Gets data for this node using the given key.

getDataKeys

open fun getDataKeys(): Set<DataKey<out Any>>

This method was added to support the clone method.

getEnd

open fun getEnd(): Optional<Position>

The end position of this node in the source file.

getId

open fun getId(): String

getLineEndingStyle

open fun getLineEndingStyle(): LineSeparator

getLineEndingStyleOrDefault

open fun getLineEndingStyleOrDefault(defaultLineSeparator: LineSeparator): LineSeparator

getMetaModel

open fun getMetaModel(): NameMetaModel

getNodesByType

open fun <N : Node?> ~~getNodesByType~~(clazz: Class<N>): List<N>

getOrphanComments

open fun getOrphanComments(): List<Comment>

This is a list of Comment which are inside the node and are not associated with any meaningful AST Node.

getParentNode

open fun getParentNode(): Optional<Node>

Returns the parent node, or Optional.empty if no parent is set.

getParentNodeForChildren

open fun getParentNodeForChildren(): Node

Returns the parent node from the perspective of the children of this node.

getParentNodeOfType

open fun <T : Node?> getParentNodeOfType(clazz: Class<T>): Optional<T>

Finds the first parent of the given class.

getQualifier

open fun getQualifier(): Optional<Name>

getRange

open fun getRange(): Optional<Range>

getSymbolResolver

open fun getSymbolResolver(): SymbolResolver

getTokenRange

open fun getTokenRange(): Optional<TokenRange>

hashCode

fun hashCode(): Int

hasParentNode

open fun hasParentNode(): Boolean

Returns true if the parent has a parent

hasQualifier

open fun hasQualifier(): Boolean

hasRange

open fun hasRange(): Boolean

hasScope

open fun hasScope(): Boolean

identifier

@NonNull

open fun identifier(): @NonNull String

isAncestorOf

open fun isAncestorOf(descendant: Node): Boolean

Determines whether this node is an ancestor of the given node.

isDescendantOf

open fun isDescendantOf(ancestor: Node): Boolean

Determines whether this HasParentNode node is a descendant of the given node.

isInternal

open fun isInternal(): Boolean

An internal name is a name that constitutes a part of a larger Name instance.

isPhantom

open fun isPhantom(): Boolean

isRegistered

open fun isRegistered(observer: AstObserver): Boolean

Was this observer registered?

isTopLevel

open fun isTopLevel(): Boolean

A top level name is a name that is not contained in a larger Name instance.

notifyPropertyChange

open fun <P> notifyPropertyChange(property: ObservableProperty, oldValue: P, newValue: P)

qualifier

@Nullable

open fun qualifier(): @Nullable Name

open fun register(observer: AstObserver)

open fun register(observer: AstObserver, mode: Node.ObserverRegistrationMode)

registerForSubtree

open fun registerForSubtree(observer: AstObserver)

remove

open fun remove(): Boolean

Try to remove this node from the parent

open fun remove(node: Node): Boolean

removeComment

open fun removeComment(): Node

removeData

open fun removeData(key: DataKey<out Any>)

Remove data by key.

removeForced

open fun removeForced()

Forcibly removes this node from the AST.

removeOrphanComment

open fun removeOrphanComment(comment: Comment): Boolean

removeQualifier

open fun removeQualifier(): Name

replace

open fun replace(node: Node): Boolean

Try to replace this node in the parent with the supplied node.

open fun replace(node: Node, replacementNode: Node): Boolean

setAssociatedSpecificationComments

open fun setAssociatedSpecificationComments(@Nullable associatedSpecificationComments: @Nullable NodeList<Comment>): Node

setBlockComment

fun setBlockComment(comment: String): Node

Use this to store additional information to this node.

setComment

open fun setComment(comment: Comment): Node

Use this to store additional information to this node.

setData

open fun <M> setData(key: DataKey<M>, object: M)

Sets data for this node using the given key.

setId

open fun setId(identifier: String): N

setIdentifier

abstract fun setIdentifier(identifier: String): N

setLineComment

fun setLineComment(comment: String): Node

Use this to store additional information to this node.

setQualifier

open fun setQualifier(@Nullable qualifier: @Nullable Name): Name

stream

open fun stream(): Stream<Node>

Make a stream of nodes using pre-order traversal.

open fun stream(traversal: Node.TreeTraversal): Stream<Node>

Make a stream of nodes using traversal algorithm "traversal".

toString

fun toString(): String

fun toString(configuration: PrinterConfiguration): String

tryAddImportToParentCompilationUnit

open fun tryAddImportToParentCompilationUnit(clazz: Class<out Any>)

unregister

open fun unregister(observer: AstObserver)

Unregister an observer.

walk

open fun walk(consumer: Consumer<Node>)

Walks the AST, calling the consumer for every node with pre-order traversal.

open fun walk(traversal: Node.TreeTraversal, consumer: Consumer<Node>)

Walks the AST, calling the consumer for every node, with traversal algorithm "traversal".

open fun <T : Node?> walk(nodeType: Class<T>, consumer: Consumer<T>)

Walks the AST with pre-order traversal, calling the consumer for every node of type "nodeType".

Name

Author

See also

Constructors

Properties

Functions