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

getAnnotation

open fun getAnnotation(i: Int): AnnotationExpr

getAnnotationByClass

open fun getAnnotationByClass(annotationClass: Class<out Annotation>): Optional<AnnotationExpr>

Try to find an annotation by its class

getAnnotationByName

open fun getAnnotationByName(annotationName: String): Optional<AnnotationExpr>

Try to find an annotation by its name

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.

getCallablesWithSignature

open fun getCallablesWithSignature(signature: CallableDeclaration.Signature): List<CallableDeclaration<out Any>>

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

abstract fun getComment(): Optional<Comment>

getConstructorByParameterTypes

open fun getConstructorByParameterTypes(paramTypes: Array<Class<out Any>>): Optional<ConstructorDeclaration>

open fun getConstructorByParameterTypes(paramTypes: Array<String>): Optional<ConstructorDeclaration>

Try to find a ConstructorDeclaration by its parameter types.

getConstructors

open fun getConstructors(): List<ConstructorDeclaration>

Find all constructors in the members of 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.

getDefaultConstructor

open fun getDefaultConstructor(): Optional<ConstructorDeclaration>

Try to find a ConstructorDeclaration with no parameters.

getEnd

open fun getEnd(): Optional<Position>

The end position of this node in the source file.

getFieldByName

open fun getFieldByName(name: String): Optional<FieldDeclaration>

Try to find a FieldDeclaration by its name

getFields

open fun getFields(): List<FieldDeclaration>

Find all fields in the members of this node.

getFullyQualifiedName

open fun getFullyQualifiedName(): Optional<String>

Returns the fully qualified name of this type, derived only from information available in this compilation unit.

getJavadoc

open fun getJavadoc(): Optional<Javadoc>

Gets the Javadoc for this node.

getJavadocComment

open fun getJavadocComment(): Optional<JavadocComment>

Gets the JavadocComment for this node.

getLineEndingStyle

open fun getLineEndingStyle(): LineSeparator

getLineEndingStyleOrDefault

open fun getLineEndingStyleOrDefault(defaultLineSeparator: LineSeparator): LineSeparator

getMember

open fun getMember(i: Int): BodyDeclaration<out Any>

getMetaModel

open fun getMetaModel(): NodeMetaModel

open fun getMetaModel(): AnnotationDeclarationMetaModel

open fun getMetaModel(): BodyDeclarationMetaModel

getMethods

open fun getMethods(): List<MethodDeclaration>

Find all methods in the members of this node.

getMethodsByName

open fun getMethodsByName(name: String): List<MethodDeclaration>

Try to find a MethodDeclaration by its name

getMethodsByParameterTypes

open fun getMethodsByParameterTypes(paramTypes: Array<Class<out Any>>): List<MethodDeclaration>

open fun getMethodsByParameterTypes(paramTypes: Array<String>): List<MethodDeclaration>

Try to find a MethodDeclaration by its parameter types.

getMethodsBySignature

open fun getMethodsBySignature(name: String, paramTypes: Array<String>): List<MethodDeclaration>

Try to find MethodDeclarations by their name and parameter types.

getNameAsExpression

open fun getNameAsExpression(): NameExpr

getNameAsString

open fun getNameAsString(): String

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.

getRange

open fun getRange(): Optional<Range>

getSymbolResolver

open fun getSymbolResolver(): SymbolResolver

getTokenRange

open fun getTokenRange(): Optional<TokenRange>

hashCode

fun hashCode(): Int

hasJavaDocComment

open fun hasJavaDocComment(): Boolean

hasModifier

open fun hasModifier(modifier: Modifier.Keyword): Boolean

hasParentNode

open fun hasParentNode(): Boolean

Returns true if the parent has a parent

hasRange

open fun hasRange(): Boolean

hasScope

open fun hasScope(): Boolean

ifAnnotationDeclaration

open fun ifAnnotationDeclaration(action: Consumer<AnnotationDeclaration>)

ifAnnotationMemberDeclaration

open fun ifAnnotationMemberDeclaration(action: Consumer<AnnotationMemberDeclaration>)

ifCallableDeclaration

open fun ifCallableDeclaration(action: Consumer<CallableDeclaration>)

ifClassInvariantClause

open fun ifClassInvariantClause(action: Consumer<JmlClassExprDeclaration>)

ifClassOrInterfaceDeclaration

open fun ifClassOrInterfaceDeclaration(action: Consumer<ClassOrInterfaceDeclaration>)

ifCompactConstructorDeclaration

open fun ifCompactConstructorDeclaration(action: Consumer<CompactConstructorDeclaration>)

ifConstructorDeclaration

open fun ifConstructorDeclaration(action: Consumer<ConstructorDeclaration>)

ifEnumConstantDeclaration

open fun ifEnumConstantDeclaration(action: Consumer<EnumConstantDeclaration>)

ifEnumDeclaration

open fun ifEnumDeclaration(action: Consumer<EnumDeclaration>)

ifFieldDeclaration

open fun ifFieldDeclaration(action: Consumer<FieldDeclaration>)

ifInitializerDeclaration

open fun ifInitializerDeclaration(action: Consumer<InitializerDeclaration>)

ifJmlClassAccessibleDeclaration

open fun ifJmlClassAccessibleDeclaration(action: Consumer<JmlClassAccessibleDeclaration>)

ifJmlClassExprDeclaration

open fun ifJmlClassExprDeclaration(action: Consumer<JmlClassExprDeclaration>)

ifJmlClassLevelDeclaration

open fun ifJmlClassLevelDeclaration(action: Consumer<JmlClassLevelDeclaration>)

ifJmlDocDeclaration

open fun ifJmlDocDeclaration(action: Consumer<JmlDocDeclaration>)

ifJmlDocType

open fun ifJmlDocType(action: Consumer<JmlDocType>)

ifJmlFieldDeclaration

open fun ifJmlFieldDeclaration(action: Consumer<JmlFieldDeclaration>)

ifJmlMethodDeclaration

open fun ifJmlMethodDeclaration(action: Consumer<JmlMethodDeclaration>)

ifJmlRepresentsDeclaration

open fun ifJmlRepresentsDeclaration(action: Consumer<JmlRepresentsDeclaration>)

ifMethodDeclaration

open fun ifMethodDeclaration(action: Consumer<MethodDeclaration>)

ifRecordDeclaration

open fun ifRecordDeclaration(action: Consumer<RecordDeclaration>)

ifTypeDeclaration

open fun ifTypeDeclaration(action: Consumer<TypeDeclaration>)

isAbstract

open fun isAbstract(): Boolean

isAncestorOf

open fun isAncestorOf(descendant: Node): Boolean

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

isAnnotationDeclaration

open fun isAnnotationDeclaration(): Boolean

isAnnotationMemberDeclaration

open fun isAnnotationMemberDeclaration(): Boolean

isAnnotationPresent

open fun isAnnotationPresent(annotationClass: Class<out Annotation>): Boolean

Check whether an annotation with this class is present on this element

open fun isAnnotationPresent(annotationName: String): Boolean

Check whether an annotation with this name is present on this element

isCallableDeclaration

open fun isCallableDeclaration(): Boolean

isClassOrInterfaceDeclaration

open fun isClassOrInterfaceDeclaration(): Boolean

isCompactConstructorDeclaration

open fun isCompactConstructorDeclaration(): Boolean

isConstructorDeclaration

open fun isConstructorDeclaration(): Boolean

isDescendantOf

open fun isDescendantOf(ancestor: Node): Boolean

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

isEmpty

open fun isEmpty(): Boolean

isEnumConstantDeclaration

open fun isEnumConstantDeclaration(): Boolean

isEnumDeclaration

open fun isEnumDeclaration(): Boolean

isFieldDeclaration

open fun isFieldDeclaration(): Boolean

isInitializerDeclaration

open fun isInitializerDeclaration(): Boolean

isJmlBodyDeclaration

open fun isJmlBodyDeclaration(): Boolean

isJmlClassAccessibleDeclaration

open fun isJmlClassAccessibleDeclaration(): Boolean

isJmlClassExprDeclaration

open fun isJmlClassExprDeclaration(): Boolean

isJmlClassLevelDeclaration

open fun isJmlClassLevelDeclaration(): Boolean

isJmlDocDeclaration

open fun isJmlDocDeclaration(): Boolean

isJmlDocType

open fun isJmlDocType(): Boolean

isJmlFieldDeclaration

open fun isJmlFieldDeclaration(): Boolean

isJmlMethodDeclaration

open fun isJmlMethodDeclaration(): Boolean

isJmlRepresentsDeclaration

open fun isJmlRepresentsDeclaration(): Boolean

isMethodDeclaration

open fun isMethodDeclaration(): Boolean

isNestedType

open fun isNestedType(): Boolean

isPhantom

open fun isPhantom(): Boolean

isPrivate

open fun isPrivate(): Boolean

isProtected

open fun isProtected(): Boolean

isPublic

open fun isPublic(): Boolean

isRecordDeclaration

open fun isRecordDeclaration(): Boolean

isRegistered

open fun isRegistered(observer: AstObserver): Boolean

Was this observer registered?

isStatic

open fun isStatic(): Boolean

isStrictfp

open fun isStrictfp(): Boolean

isTopLevelType

open fun isTopLevelType(): Boolean

isTypeDeclaration

open fun isTypeDeclaration(): Boolean

members

@NonNull

open fun members(): @NonNull NodeList<BodyDeclaration<out Any>>

modifiers

@NonNull

open fun modifiers(): @NonNull NodeList<Modifier>

name

@NonNull

open fun name(): @NonNull SimpleName

notifyPropertyChange

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

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.

removeJavaDocComment

open fun removeJavaDocComment(): Boolean

removeModifier

open fun removeModifier(modifiersToRemove: Array<Modifier.Keyword>): N

removeOrphanComment

open fun removeOrphanComment(comment: Comment): Boolean

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

resolve

open fun resolve(): ResolvedAnnotationDeclaration

setAbstract

open fun setAbstract(set: Boolean): N

setAnnotation

open fun setAnnotation(i: Int, element: AnnotationExpr): N

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.

setData

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

Sets data for this node using the given key.

setJavadocComment

open fun setJavadocComment(comment: JavadocComment): N

open fun setJavadocComment(javadoc: Javadoc): N

open fun setJavadocComment(indentation: String, javadoc: Javadoc): N

open fun setJavadocComment(comment: String): N

open fun setJavadocComment(comment: String, isMarkdownComment: Boolean): N

Set a JavadocComment for this node

setLineComment

fun setLineComment(comment: String): Node

Use this to store additional information to this node.

setMember

open fun setMember(i: Int, member: BodyDeclaration<out Any>): N

setModifier

open fun setModifier(m: Modifier.Keyword, set: Boolean): N

setModifiers

open fun setModifiers(modifiers: Array<Modifier.Keyword>): N

open fun setModifiers(modifiers: List<Modifier.Keyword>): N

Creates a list of modifier nodes corresponding to the keywords passed, and set it.

setName

open fun setName(name: String): N

setPrivate

open fun setPrivate(set: Boolean): N

setProtected

open fun setProtected(set: Boolean): N

setPublic

open fun setPublic(set: Boolean): N

setStatic

open fun setStatic(set: Boolean): N

setStrictfp

open fun setStrictfp(set: Boolean): N

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".

toAnnotationDeclaration

open fun toAnnotationDeclaration(): Optional<AnnotationDeclaration>

toAnnotationMemberDeclaration

open fun toAnnotationMemberDeclaration(): Optional<AnnotationMemberDeclaration>

toCallableDeclaration

open fun toCallableDeclaration(): Optional<CallableDeclaration>

toClassOrInterfaceDeclaration

open fun toClassOrInterfaceDeclaration(): Optional<ClassOrInterfaceDeclaration>

toCompactConstructorDeclaration

open fun toCompactConstructorDeclaration(): Optional<CompactConstructorDeclaration>

toConstructorDeclaration

open fun toConstructorDeclaration(): Optional<ConstructorDeclaration>

toEnumConstantDeclaration

open fun toEnumConstantDeclaration(): Optional<EnumConstantDeclaration>

toEnumDeclaration

open fun toEnumDeclaration(): Optional<EnumDeclaration>

toFieldDeclaration

open fun toFieldDeclaration(): Optional<FieldDeclaration>

toInitializerDeclaration

open fun toInitializerDeclaration(): Optional<InitializerDeclaration>

toJmlClassAccessibleDeclaration

open fun toJmlClassAccessibleDeclaration(): Optional<JmlClassAccessibleDeclaration>

toJmlClassExprDeclaration

open fun toJmlClassExprDeclaration(): Optional<JmlClassExprDeclaration>

toJmlClassLevelDeclaration

open fun toJmlClassLevelDeclaration(): Optional<JmlClassLevelDeclaration>

toJmlDocDeclaration

open fun toJmlDocDeclaration(): Optional<JmlDocDeclaration>

toJmlDocType

open fun toJmlDocType(): Optional<JmlDocType>

toJmlFieldDeclaration

open fun toJmlFieldDeclaration(): Optional<JmlFieldDeclaration>

toJmlMethodDeclaration

open fun toJmlMethodDeclaration(): Optional<JmlMethodDeclaration>

toJmlRepresentsDeclaration

open fun toJmlRepresentsDeclaration(): Optional<JmlRepresentsDeclaration>

toMethodDeclaration

open fun toMethodDeclaration(): Optional<MethodDeclaration>

toRecordDeclaration

open fun toRecordDeclaration(): Optional<RecordDeclaration>

toString

fun toString(): String

fun toString(configuration: PrinterConfiguration): String

toTypeDeclaration

open fun toTypeDeclaration(): Optional<TypeDeclaration>

tryAddImportToParentCompilationUnit

abstract 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".