CompilationUnit (org.macroing.cel4j.java.source API)

java.lang.Object
- org.macroing.cel4j.java.source.syntactic.CompilationUnit

All Implemented Interfaces:

org.macroing.cit.java.util.node.Node
```
public final class CompilationUnit
extends java.lang.Object
implements org.macroing.cit.java.util.node.Node
```
A CompilationUnit denotes the nonterminal symbol CompilationUnit, as defined by the Java Language Specification.
This class is mutable and therefore not suitable for concurrent use without external synchronization.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(org.macroing.cit.java.util.node.NodeHierarchicalVisitor nodeHierarchicalVisitor)` Accepts a `NodeHierarchicalVisitor`.
`void`	`addComment(Comment comment)` Adds a `Comment` to the end of this `CompilationUnit` instance.
`void`	`addImportDeclaration(ImportDeclaration importDeclaration)` Adds an `ImportDeclaration` to the end of the `ImportDeclaration`s section of this `CompilationUnit` instance.
`void`	`addTypeDeclaration(TypeDeclaration typeDeclaration)` Adds a `TypeDeclaration` to the end of the `TypeDeclaration`s section of this `CompilationUnit` instance.
`void`	`addWhiteSpace(WhiteSpace whiteSpace)` Adds a `WhiteSpace` to the end of this `CompilationUnit` instance.
`boolean`	`equals(java.lang.Object object)` Returns `true` if, and only if, `object` is an instance of `CompilationUnit`, and that `CompilationUnit` instance is equal to this `CompilationUnit` instance, `false` otherwise.
`java.util.List<ImportDeclaration>`	`getImportDeclarations()` Returns a `List` with all currently added `ImportDeclaration`s.
`java.util.List<TypeDeclaration>`	`getTypeDeclarations()` Returns a `List` with all currently added `TypeDeclaration`s.
`int`	`hashCode()` Returns a hash code for this `CompilationUnit` instance.
`static CompilationUnit`	`newInstance()` Returns a new empty `CompilationUnit` instance.
`void`	`removeComment(Comment comment)` Removes the first `Comment` from the end of this `CompilationUnit` instance, that is equal to `comment`.
`void`	`removeImportDeclaration(ImportDeclaration importDeclaration)` Removes the first `ImportDeclaration` from the end of the `ImportDeclaration`s section of this `CompilationUnit` instance, that is equal to `importDeclaration`.
`void`	`removeTypeDeclaration(TypeDeclaration typeDeclaration)` Removes the first `TypeDeclaration` from the end of the `TypeDeclaration`s section of this `CompilationUnit` instance, that is equal to `typeDeclaration`.
`void`	`removeWhiteSpace(WhiteSpace whiteSpace)` Removes the first `WhiteSpace` from the end of this `CompilationUnit` instance, that is equal to `whiteSpace`.
`java.lang.String`	`toString()` Returns a `String` representation of this `CompilationUnit` instance.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.macroing.cit.java.util.node.Node
accept

- Method Detail
  - accept
```
public boolean accept(org.macroing.cit.java.util.node.NodeHierarchicalVisitor nodeHierarchicalVisitor)
```
    Accepts a NodeHierarchicalVisitor.
    Returns the result of nodeHierarchicalVisitor.visitLeave(this).
    If nodeHierarchicalVisitor is null, a NullPointerException will be thrown.
    If a RuntimeException is thrown by the current NodeHierarchicalVisitor, a NodeTraversalException will be thrown with the RuntimeException wrapped.
    This implementation will:
    - throw a NullPointerException if nodeHierarchicalVisitor is null.
    - throw a NodeTraversalException if nodeHierarchicalVisitor throws a RuntimeException.
    - traverse its child Nodes, if it has any.
    Specified by:
    
    accept in interface org.macroing.cit.java.util.node.Node
    
    Parameters:
    
    nodeHierarchicalVisitor - the NodeHierarchicalVisitor to accept
    
    Returns:
    
    the result of nodeHierarchicalVisitor.visitLeave(this)
    
    Throws:
    
    org.macroing.cit.java.util.node.NodeTraversalException - thrown if, and only if, a RuntimeException is thrown by the current NodeHierarchicalVisitor
    
    java.lang.NullPointerException - thrown if, and only if, nodeHierarchicalVisitor is null
  - equals
```
public boolean equals(java.lang.Object object)
```
    Returns true if, and only if, object is an instance of CompilationUnit, and that CompilationUnit instance is equal to this CompilationUnit instance, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - an Object to compare to this CompilationUnit instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of CompilationUnit, and that CompilationUnit instance is equal to this CompilationUnit instance, false otherwise
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this CompilationUnit instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this CompilationUnit instance
  - getImportDeclarations
```
public java.util.List<ImportDeclaration> getImportDeclarations()
```
    Returns a List with all currently added ImportDeclarations.
    Any modifications made to the returned List will not affect this CompilationUnit instance.
    However, modifications made to any of the returned Lists elements, will indirectly affect this CompilationUnit instance.
    
    Returns:
    
    a List with all currently added ImportDeclarations
  - getTypeDeclarations
```
public java.util.List<TypeDeclaration> getTypeDeclarations()
```
    Returns a List with all currently added TypeDeclarations.
    Any modifications made to the returned List will not affect this CompilationUnit instance.
    However, modifications made to any of the returned Lists elements, will indirectly affect this CompilationUnit instance.
    
    Returns:
    
    a List with all currently added TypeDeclarations
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this CompilationUnit instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this CompilationUnit instance
  - addComment
```
public void addComment(Comment comment)
```
    Adds a Comment to the end of this CompilationUnit instance.
    If comment is null, a NullPointerException will be thrown.
    
    Parameters:
    
    comment - the Comment to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, comment is null
  - addImportDeclaration
```
public void addImportDeclaration(ImportDeclaration importDeclaration)
```
    Adds an ImportDeclaration to the end of the ImportDeclarations section of this CompilationUnit instance.
    If importDeclaration is null, a NullPointerException will be thrown.
    
    Parameters:
    
    importDeclaration - the ImportDeclaration to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, importDeclaration is null
  - addTypeDeclaration
```
public void addTypeDeclaration(TypeDeclaration typeDeclaration)
```
    Adds a TypeDeclaration to the end of the TypeDeclarations section of this CompilationUnit instance.
    If typeDeclaration is null, a NullPointerException will be thrown.
    
    Parameters:
    
    typeDeclaration - the TypeDeclaration to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, typeDeclaration is null
  - addWhiteSpace
```
public void addWhiteSpace(WhiteSpace whiteSpace)
```
    Adds a WhiteSpace to the end of this CompilationUnit instance.
    If whiteSpace is null, a NullPointerException will be thrown.
    
    Parameters:
    
    whiteSpace - the WhiteSpace to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, whiteSpace is null
  - removeComment
```
public void removeComment(Comment comment)
```
    Removes the first Comment from the end of this CompilationUnit instance, that is equal to comment.
    If comment is null, a NullPointerException will be thrown.
    
    Parameters:
    
    comment - the Comment to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, comment is null
  - removeImportDeclaration
```
public void removeImportDeclaration(ImportDeclaration importDeclaration)
```
    Removes the first ImportDeclaration from the end of the ImportDeclarations section of this CompilationUnit instance, that is equal to importDeclaration.
    If importDeclaration is null, a NullPointerException will be thrown.
    
    Parameters:
    
    importDeclaration - the ImportDeclaration to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, importDeclaration is null
  - removeTypeDeclaration
```
public void removeTypeDeclaration(TypeDeclaration typeDeclaration)
```
    Removes the first TypeDeclaration from the end of the TypeDeclarations section of this CompilationUnit instance, that is equal to typeDeclaration.
    If typeDeclaration is null, a NullPointerException will be thrown.
    
    Parameters:
    
    typeDeclaration - the TypeDeclaration to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, typeDeclaration is null
  - removeWhiteSpace
```
public void removeWhiteSpace(WhiteSpace whiteSpace)
```
    Removes the first WhiteSpace from the end of this CompilationUnit instance, that is equal to whiteSpace.
    If whiteSpace is null, a NullPointerException will be thrown.
    
    Parameters:
    
    whiteSpace - the WhiteSpace to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, whiteSpace is null
  - newInstance
```
public static CompilationUnit newInstance()
```
    Returns a new empty CompilationUnit instance.
    
    Returns:
    
    a new empty CompilationUnit instance

Class CompilationUnit

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.macroing.cit.java.util.node.Node

Method Detail

accept

equals

hashCode

getImportDeclarations

getTypeDeclarations

toString

addComment

addImportDeclaration

addTypeDeclaration

addWhiteSpace

removeComment

removeImportDeclaration

removeTypeDeclaration

removeWhiteSpace

newInstance