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

java.lang.Object
- org.macroing.cel4j.java.source.lexical.Input

All Implemented Interfaces:

java.lang.Iterable<InputElement>, java.util.function.Supplier<java.util.List<InputElement>>, org.macroing.cit.java.util.function.ListSupplier<InputElement>, org.macroing.cit.java.util.node.Node
```
public final class Input
extends java.lang.Object
implements java.lang.Iterable<InputElement>, org.macroing.cit.java.util.function.ListSupplier<InputElement>, org.macroing.cit.java.util.node.Node
```
An Input denotes the nonterminal symbol Input, as defined by the Java Language Specification.

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`	`addInputElement(InputElement inputElement)` Adds an `InputElement` to this `Input` instance.
`boolean`	`equals(java.lang.Object object)` Returns `true` if, and only if, `object` is an instance of `Input`, and that `Input` instance is equal to this `Input` instance, `false` otherwise.
`java.util.List<InputElement>`	`get()` Returns a `List` with all currently added `InputElement`s.
`java.util.List<InputElement>`	`getInputElements()` Returns a `List` with all currently added `InputElement`s.
`int`	`hashCode()` Returns a hash-code for this `Input` instance.
`boolean`	`hasSubAtEnd()` Returns `true` if, and only if, a Sub or Control-Z has been added to the end, `false` otherwise.
`java.util.Iterator<InputElement>`	`iterator()` Returns an `Iterator` over all currently added `InputElement`s.
`static Input`	`newInstance()` Returns a new empty `Input` instance.
`static Input`	`parseInput(java.io.File file)` Parses the content of a file as an `Input` instance.
`static Input`	`parseInput(java.lang.String string)` Parses the content of the suppled `String` as an `Input` instance.
`void`	`removeInputElement(InputElement inputElement)` Removes an `InputElement` from this `Input` instance.
`void`	`setSubAtEnd(boolean hasSubAtEnd)` Sets the state of the Sub or Control-Z at the end of this `Input` instance.
`java.lang.String`	`toString()` Returns a `String` representation of this `Input` instance.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

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 Input, and that Input instance is equal to this Input instance, false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    true if, and only if, object is an instance of Input, and that Input instance is equal to this Input instance, false otherwise
  - hasSubAtEnd
```
public boolean hasSubAtEnd()
```
    Returns true if, and only if, a Sub or Control-Z has been added to the end, false otherwise.
    
    Returns:
    
    true if, and only if, a Sub or Control-Z has been added to the end, false otherwise
  - hashCode
```
public int hashCode()
```
    Returns a hash-code for this Input instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    a hash-code for this Input instance
  - iterator
```
public java.util.Iterator<InputElement> iterator()
```
    Returns an Iterator over all currently added InputElements.
    Removing an InputElement via the Iterator will not affect the internal state of this Input instance.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<InputElement>
    
    Returns:
    
    an Iterator over all currently added InputElements
  - get
```
public java.util.List<InputElement> get()
```
    Returns a List with all currently added InputElements.
    Modifications made to the returned List will not affect the internal state of this Input instance.
    
    Specified by:
    
    get in interface java.util.function.Supplier<java.util.List<InputElement>>
    
    Specified by:
    
    get in interface org.macroing.cit.java.util.function.ListSupplier<InputElement>
    
    Returns:
    
    a List with all currently added InputElements
  - getInputElements
```
public java.util.List<InputElement> getInputElements()
```
    Returns a List with all currently added InputElements.
    Modifications made to the returned List will not affect the internal state of this Input instance.
    
    Returns:
    
    a List with all currently added InputElements
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this Input instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this Input instance
  - addInputElement
```
public void addInputElement(InputElement inputElement)
```
    Adds an InputElement to this Input instance.
    If inputElement is null, a NullPointerException will be thrown.
    
    Parameters:
    
    inputElement - the InputElement to add
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, inputElement is null
  - removeInputElement
```
public void removeInputElement(InputElement inputElement)
```
    Removes an InputElement from this Input instance.
    If inputElement is null, a NullPointerException will be thrown.
    
    Parameters:
    
    inputElement - the InputElement to remove
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, inputElement is null
  - setSubAtEnd
```
public void setSubAtEnd(boolean hasSubAtEnd)
```
    Sets the state of the Sub or Control-Z at the end of this Input instance.
    
    Parameters:
    
    hasSubAtEnd - true for Sub or Control-Z at the end
  - newInstance
```
public static Input newInstance()
```
    Returns a new empty Input instance.
    
    Returns:
    
    a new empty Input instance
  - parseInput
```
public static Input parseInput(java.io.File file)
```
    Parses the content of a file as an Input instance.
    Returns an Input instance.
    If file is null, a NullPointerException will be thrown.
    If the file cannot be read, an UncheckedIOException will be thrown.
    
    Parameters:
    
    file - a File denoting the file from which to parse
    
    Returns:
    
    an Input instance
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, file is null
    
    java.io.UncheckedIOException - thrown if, and only if, the file cannot be read
  - parseInput
```
public static Input parseInput(java.lang.String string)
```
    Parses the content of the suppled String as an Input instance.
    Returns an Input instance.
    If string is null, a NullPointerException will be thrown.
    
    Parameters:
    
    string - the String with the content to parse
    
    Returns:
    
    an Input instance
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, string is null

Class Input

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

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

Method Detail

accept

equals

hasSubAtEnd

hashCode

iterator

get

getInputElements

toString

addInputElement

removeInputElement

setSubAtEnd

newInstance

parseInput

parseInput