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

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

All Implemented Interfaces:

BlockStatement, MethodBody, Statement, StatementNoShortIf, StatementWithoutTrailingSubstatement, org.macroing.cit.java.util.node.Node
```
public final class Block
extends java.lang.Object
implements MethodBody, StatementWithoutTrailingSubstatement
```
A Block denotes the nonterminal symbol Block, 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`	`addBlockStatement(BlockStatement blockStatement)` Adds a `BlockStatement` to the end of the `BlockStatement`s section of this `Block` instance.
`void`	`addComment(Comment comment)` Adds a `Comment` to the end of this `Block` instance.
`void`	`addWhiteSpace(WhiteSpace whiteSpace)` Adds a `WhiteSpace` to the end of this `Block` instance.
`boolean`	`equals(java.lang.Object object)` Returns `true` if, and only if, `object` is an instance of `Block`, and that `Block` instance is equal to this `Block` instance, `false` otherwise.
`java.util.List<BlockStatement>`	`getBlockStatements()` Returns a `List` with all currently added `BlockStatement`s.
`int`	`hashCode()` Returns a hash code for this `Block` instance.
`boolean`	`isIterationStatement()` Returns `true` if, and only if, this `Statement` is an iteration statement, `false` otherwise.
`static Block`	`newInstance()` Returns a new empty `Block` instance.
`void`	`removeBlockStatement(BlockStatement blockStatement)` Removes the first `BlockStatement` from the end of the `BlockStatement`s section of this `Block` instance, that is equal to `blockStatement`.
`void`	`removeComment(Comment comment)` Removes the first `Comment` from the end of this `Block` instance, that is equal to `comment`.
`void`	`removeWhiteSpace(WhiteSpace whiteSpace)` Removes the first `WhiteSpace` from the end of this `Block` instance, that is equal to `whiteSpace`.
`java.lang.String`	`toString()` Returns a `String` representation of this `Block` 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 Block, and that Block instance is equal to this Block instance, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - an Object to compare to this Block instance for equality
    
    Returns:
    
    true if, and only if, object is an instance of Block, and that Block instance is equal to this Block instance, false otherwise
  - isIterationStatement
```
public boolean isIterationStatement()
```
    Returns true if, and only if, this Statement is an iteration statement, false otherwise.
    This implementation returns false, as a Block is not an iteration statement.
    
    Specified by:
    
    isIterationStatement in interface Statement
    
    Specified by:
    
    isIterationStatement in interface StatementNoShortIf
    
    Returns:
    
    true if, and only if, this Statement is an iteration statement, false otherwise
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this Block instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash code for this Block instance
  - getBlockStatements
```
public java.util.List<BlockStatement> getBlockStatements()
```
    Returns a List with all currently added BlockStatements.
    Any modifications made to the returned List will not affect this Block instance.
    However, modifications made to any of the returned Lists elements, will indirectly affect this Block instance.
    
    Returns:
    
    a List with all currently added BlockStatements
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this Block instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this Block instance
  - addComment
```
public void addComment(Comment comment)
```
    Adds a Comment to the end of this Block 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
  - addBlockStatement
```
public void addBlockStatement(BlockStatement blockStatement)
```
    Adds a BlockStatement to the end of the BlockStatements section of this Block instance.
    If blockStatement is null, a NullPointerException will be thrown.
    
    Parameters:
    
    blockStatement - the BlockStatement to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, blockStatement is null
  - addWhiteSpace
```
public void addWhiteSpace(WhiteSpace whiteSpace)
```
    Adds a WhiteSpace to the end of this Block 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 Block 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
  - removeBlockStatement
```
public void removeBlockStatement(BlockStatement blockStatement)
```
    Removes the first BlockStatement from the end of the BlockStatements section of this Block instance, that is equal to blockStatement.
    If blockStatement is null, a NullPointerException will be thrown.
    
    Parameters:
    
    blockStatement - the BlockStatement to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, blockStatement is null
  - removeWhiteSpace
```
public void removeWhiteSpace(WhiteSpace whiteSpace)
```
    Removes the first WhiteSpace from the end of this Block 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 Block newInstance()
```
    Returns a new empty Block instance.
    
    Returns:
    
    a new empty Block instance

Class Block

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

accept

equals

isIterationStatement

hashCode

getBlockStatements

toString

addComment

addBlockStatement

addWhiteSpace

removeComment

removeBlockStatement

removeWhiteSpace

newInstance