com.github.fge.grappa.buffers

Class CharSequenceInputBuffer

java.lang.Object

com.github.fge.grappa.buffers.CharSequenceInputBuffer

All Implemented Interfaces:

InputBuffer

@Immutable
public final class CharSequenceInputBuffer
extends Object
implements InputBuffer

An InputBuffer over a CharSequence

A CharSequence is the most basic character interface in the JDK. It is implemented by a lot of character related classes, including String, and is also the argument type used by a Pattern's Matcher.

Among other things, this means you can use this package on very large files using largetext, which implements CharSequence over multi-gigabyte files.

Constructor Summary

Constructors

Constructor and Description
CharSequenceInputBuffer(CharSequence charSequence)

Method Summary

Methods

Modifier and Type	Method and Description
char	charAt(int index) Returns the character at the given index.
int	codePointAt(int index) Returns the Unicode code point starting at a given index
String	extract(IndexRange range) Constructs a new String from all character covered by the given IndexRange.
String	extract(int start, int end) Constructs a new String from all character between the given indices.
String	extractLine(int lineNumber) Constructs a new String containing all characters with the given line number except for the trailing newline.
int	getLineCount() Returns the number of lines in the input buffer.
IndexRange	getLineRange(int lineNumber) Get the index range matching a given line number
Position	getPosition(int index) Returns the line and column number of the character with the given index encapsulated in a Position object.
int	length()

Methods inherited from class java.lang.Object

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

Constructor Detail

CharSequenceInputBuffer

public CharSequenceInputBuffer(@Nonnull
                       CharSequence charSequence)

Method Detail

charAt

public char charAt(int index)

Description copied from interface: InputBuffer

Returns the character at the given index.

If the index is greater than, or equal to, the buffer's length, this method returns Chars.EOI.

Specified by:

charAt in interface InputBuffer

Parameters:

index - the index

Returns:

the character at the given index or Chars.EOI.

codePointAt

public int codePointAt(int index)

Description copied from interface: InputBuffer

Returns the Unicode code point starting at a given index

If the index is greater than, or equal to, the buffer's length, this method returns -1.

Specified by:

codePointAt in interface InputBuffer

Parameters:

index - the index

Returns:

the code point at this index, or -1 if the end of input has been reached

extract

public String extract(int start,
             int end)

Description copied from interface: InputBuffer

Constructs a new String from all character between the given indices. Invalid indices are automatically adjusted to their respective boundary.

Specified by:

extract in interface InputBuffer

Parameters:

start - the start index (inclusively)

end - the end index (exclusively)

Returns:

a new String (non-interned)

extract

public String extract(IndexRange range)

Description copied from interface: InputBuffer

Constructs a new String from all character covered by the given IndexRange.

Specified by:

extract in interface InputBuffer

Parameters:

range - the IndexRange

Returns:

a new String (non-interned)

getPosition

public Position getPosition(int index)

Description copied from interface: InputBuffer

Returns the line and column number of the character with the given index encapsulated in a Position object. The very first character has the line number 1 and the column number 1.

Specified by:

getPosition in interface InputBuffer

Parameters:

index - the index of the character to get the line number of

Returns:

the line number

extractLine

public String extractLine(int lineNumber)

Description copied from interface: InputBuffer

Constructs a new String containing all characters with the given line number except for the trailing newline.

Specified by:

extractLine in interface InputBuffer

Parameters:

lineNumber - the line number to get

Returns:

the string

getLineRange

public IndexRange getLineRange(int lineNumber)

Description copied from interface: InputBuffer

Get the index range matching a given line number

Specified by:

getLineRange in interface InputBuffer

Parameters:

lineNumber - the line number

Returns:

the index range

getLineCount

public int getLineCount()

Description copied from interface: InputBuffer

Returns the number of lines in the input buffer.

Specified by:

getLineCount in interface InputBuffer

Returns:

number of lines in the input buffer.

length

public int length()

Specified by:

length in interface InputBuffer