Package jjparse.input

Class CharacterInput

java.lang.Object

jjparse.input.Input<Character>

jjparse.input.CharacterInput

All Implemented Interfaces:

CharSequence

public final class CharacterInput
extends Input<Character>
implements CharSequence

A specific implementation of an Input for Characters that also implements the CharSequence interface. Input<Character>.Positions returned by this Input are aware of unicode code points such that calling Input.Position.toString() shows the line and column numbers as they are perceived by the user. Instances of this class can be obtained using one of the variants of Input.of(java.lang.String, java.util.Iterator<T>).

Author:

Björn Lötters

See Also:

• Input
• Input.of(java.lang.String, java.util.Iterator<T>)
• Character
• CharSequence

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	CharacterInput.CodePointPosition	Represents a Input<Character>.Position in this CharacterInput that is aware of the underlying unicode code points.

Nested classes/interfaces inherited from class jjparse.input.Input

Input.Position

Field Summary

Fields inherited from class jjparse.input.Input

name

Method Summary

Modifier and Type	Method	Description
char	charAt(int index)
Character	head()	Returns the first element of this Input.
boolean	isEmpty()	Checks whether this Input is empty.
int	length()
CharacterInput.CodePointPosition	position()	A Input<T>.Position that points to the first element in this Input.
CharacterInput	subSequence(int start, int end)
Input<Character>	tail()	Returns the rest of this Input, excluding its first element.
String	toString()

Methods inherited from class jjparse.input.Input

empty, nonEmpty, of, of, of, of, of, of, of

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Method Details

isEmpty

public boolean isEmpty()

Description copied from class: Input

Checks whether this Input is empty.

Specified by:

isEmpty in interface CharSequence

Specified by:

isEmpty in class Input<Character>

Returns:

true if this Input is empty.

See Also:

• Input.nonEmpty()

head

public Character head()
               throws NoSuchElementException

Description copied from class: Input

Returns the first element of this Input. If this Input is empty, an exception is thrown.

Specified by:

head in class Input<Character>

Returns:

The first element of this Input.

Throws:

NoSuchElementException - If this Input is empty.

See Also:

• Input.isEmpty()
• Input.tail()

tail

public Input<Character> tail()

Description copied from class: Input

Returns the rest of this Input, excluding its first element. If this Input is empty, an empty Input is returned.

Specified by:

tail in class Input<Character>

Returns:

The rest of this Input or an empty Input, if this Input is empty.

See Also:

• Input.isEmpty()
• Input.head()

position

public CharacterInput.CodePointPosition position()

Description copied from class: Input

A Input<T>.Position that points to the first element in this Input.

Specified by:

position in class Input<Character>

Returns:

The Input<T>.Position of the first element in this Input.

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharacterInput subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object