jmlparser-core/com.github.javaparser.ast/CompilationUnit

CompilationUnit

open class CompilationUnit : Node(source)

This class represents the entire compilation unit. Each java file denotes a compilation unit.

A compilation unit start with an optional package declaration, followed by zero or more import declarations, followed by zero or more type declarations.

Author

Julio Vilmar Gesser

Constructors

CompilationUnit

constructor()

constructor(packageDeclaration: String)

constructor(packageDeclaration: PackageDeclaration, imports: NodeList<ImportDeclaration>, types: NodeList<TypeDeclaration<out Any>>, module: ModuleDeclaration)

constructor(tokenRange: TokenRange, packageDeclaration: PackageDeclaration, imports: NodeList<ImportDeclaration>, types: NodeList<TypeDeclaration<out Any>>, module: ModuleDeclaration)

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

Types

Storage

open class Storage

Information about where this compilation unit was loaded from.

Properties

ABSOLUTE_BEGIN_LINE

val ~~ABSOLUTE_BEGIN_LINE~~: Int = -1

ABSOLUTE_END_LINE

val ~~ABSOLUTE_END_LINE~~: Int = -2

imports

open var imports: NodeList<ImportDeclaration>

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

types

open var types: NodeList<TypeDeclaration<out Any>>

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.

addAnnotationDeclaration

open fun addAnnotationDeclaration(name: String): AnnotationDeclaration

Add a public annotation declaration to the types of this compilation unit

open fun addAnnotationDeclaration(name: String, modifiers: Array<Modifier.DefaultKeyword>): AnnotationDeclaration

Add an annotation declaration to the types of this compilation unit

addClass

open fun addClass(name: String): ClassOrInterfaceDeclaration

Add a public class to the types of this compilation unit

open fun addClass(name: String, modifiers: Array<Modifier.DefaultKeyword>): ClassOrInterfaceDeclaration

Add a class to the types of this compilation unit

addEnum

open fun addEnum(name: String): EnumDeclaration

Add a public enum to the types of this compilation unit

open fun addEnum(name: String, modifiers: Array<Modifier.DefaultKeyword>): EnumDeclaration

Add an enum to the types of this compilation unit

addImport

open fun addImport(importDeclaration: ImportDeclaration): CompilationUnit

adds an import if not implicitly imported by java (i.e.

open fun addImport(clazz: Class<out Any>): CompilationUnit

Add an import to the list of ImportDeclaration of this compilation unit shorthand for addImport with clazz.

open fun addImport(name: String): CompilationUnit

Add an import to the list of ImportDeclaration of this compilation unit shorthand for addImport with name,false,false,false

open fun addImport(name: String, isStatic: Boolean, isAsterisk: Boolean): CompilationUnit

Add a non-module import to the list of ImportDeclaration of this compilation unitThis method check if no import with the same name is already in the list

open fun addImport(name: String, isStatic: Boolean, isAsterisk: Boolean, isModule: Boolean): CompilationUnit

Add an import to the list of ImportDeclaration of this compilation unitThis method check if no import with the same name is already in the list

addInterface

open fun addInterface(name: String): ClassOrInterfaceDeclaration

Add a public interface class to the types of this compilation unit

open fun addInterface(name: String, modifiers: Array<Modifier.DefaultKeyword>): ClassOrInterfaceDeclaration

Add an interface to the types of this compilation unit

addOrphanComment

open fun addOrphanComment(comment: Comment)

addType

open fun addType(type: TypeDeclaration<out Any>): CompilationUnit

associatedSpecificationComments

@Nullable

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

clone

open fun clone(): CompilationUnit

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.

getAllComments

open fun getAllComments(): List<Comment>

Return a list containing all comments declared in this compilation unit.

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

getAnnotationDeclarationByName

open fun getAnnotationDeclarationByName(annotationName: String): Optional<AnnotationDeclaration>

Try to get a top level annotation type declaration 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.

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.

getClassByName

open fun getClassByName(className: String): Optional<ClassOrInterfaceDeclaration>

Try to get a top level class declaration by its name

getComment

open fun getComment(): Optional<Comment>

This is a comment associated with this node.

getComments

open fun ~~getComments~~(): List<Comment>

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.

getEnumByName

open fun getEnumByName(enumName: String): Optional<EnumDeclaration>

Try to get a top level enum declaration by its name

getImport

open fun getImport(i: Int): ImportDeclaration

getInterfaceByName

open fun getInterfaceByName(interfaceName: String): Optional<ClassOrInterfaceDeclaration>

Try to get a top level interface declaration by its name

getLineEndingStyle

open fun getLineEndingStyle(): LineSeparator

getLineEndingStyleOrDefault

open fun getLineEndingStyleOrDefault(defaultLineSeparator: LineSeparator): LineSeparator

getLocalDeclarationFromClassname

open fun getLocalDeclarationFromClassname(className: String): List<ClassOrInterfaceDeclaration>

Try to get all local class declarations ending by its name (top level or inner class)

getMetaModel

open fun getMetaModel(): CompilationUnitMetaModel

getModule

open fun getModule(): Optional<ModuleDeclaration>

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.

getPackageDeclaration

open fun getPackageDeclaration(): Optional<PackageDeclaration>

Retrieves the package declaration of this compilation unit.

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.

getPrimaryType

open fun getPrimaryType(): Optional<TypeDeclaration<out Any>>

getPrimaryTypeName

open fun getPrimaryTypeName(): Optional<String>

getRange

open fun getRange(): Optional<Range>

getRecordByName

open fun getRecordByName(recordName: String): Optional<RecordDeclaration>

Try to get a top level record declaration by its name

getStorage

open fun getStorage(): Optional<CompilationUnit.Storage>

getSymbolResolver

open fun getSymbolResolver(): SymbolResolver

getTokenRange

open fun getTokenRange(): Optional<TokenRange>

getType

open fun getType(i: Int): TypeDeclaration<out Any>

Convenience method that wraps getTypes().

hashCode

fun hashCode(): Int

hasParentNode

open fun hasParentNode(): Boolean

Returns true if the parent has a parent

hasRange

open fun hasRange(): Boolean

hasScope

open fun hasScope(): Boolean

imports

@NonNull

open fun imports(): @NonNull NodeList<ImportDeclaration>

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.

isPhantom

open fun isPhantom(): Boolean

isRegistered

open fun isRegistered(observer: AstObserver): Boolean

Was this observer registered?

module

@Nullable

open fun module(): @Nullable ModuleDeclaration

notifyPropertyChange

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

packageDeclaration

@Nullable

open fun packageDeclaration(): @Nullable PackageDeclaration

printer

open fun printer(printer: Printer): CompilationUnit

Declare a specific printer

recalculatePositions

open fun recalculatePositions()

Recalculates the ranges of all nodes by looking at the sizes of the tokens.

open fun register(observer: AstObserver)

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

registerForSubtree

open fun registerForSubtree(observer: AstObserver)

remove

open fun remove(node: Node): Boolean

open fun remove(): Boolean

Try to remove this node from the parent

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.

removeModule

open fun removeModule(): CompilationUnit

removeOrphanComment

open fun removeOrphanComment(comment: Comment): Boolean

removePackageDeclaration

open fun removePackageDeclaration(): CompilationUnit

replace

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

open fun replace(node: Node): Boolean

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

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.

setImport

open fun setImport(i: Int, imports: ImportDeclaration): CompilationUnit

setLineComment

fun setLineComment(comment: String): Node

Use this to store additional information to this node.

setModule

open fun setModule(@Nullable module: @Nullable ModuleDeclaration): CompilationUnit

open fun setModule(name: String): ModuleDeclaration

Create (or overwrite) a module declaration in this compilation unit with name "name".

setPackageDeclaration

open fun setPackageDeclaration(@Nullable packageDeclaration: @Nullable PackageDeclaration): CompilationUnit

Sets or clear the package declarations of this compilation unit.

open fun setPackageDeclaration(name: String): CompilationUnit

sets the package declaration of this compilation unit

setStorage

open fun setStorage(path: Path): CompilationUnit

open fun setStorage(path: Path, charset: Charset): CompilationUnit

setType

open fun setType(i: Int, type: TypeDeclaration<out Any>): CompilationUnit

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>)

types

@NonNull

open fun types(): @NonNull NodeList<TypeDeclaration<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".

CompilationUnit

Author

See also

Constructors

Types

Properties

Functions