Index

A B C E F G H I L N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractCharStreamScanner - Class in io.github.mmm.scanner

Abstract implementation of CharStreamScanner.
ATTENTION:
This implementation and its sub-classes are NOT thread-safe and have no intention to be thread-safe.

AbstractCharStreamScanner(char[]) - Constructor for class io.github.mmm.scanner.AbstractCharStreamScanner

The constructor.

AbstractCharStreamScanner(int) - Constructor for class io.github.mmm.scanner.AbstractCharStreamScanner

The constructor.

append(StringBuilder, int, int) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

appendSubstring(StringBuilder, int, int) - Method in class io.github.mmm.scanner.CharSequenceScanner

This method appends the substring specified by start and end to the given buffer.

B

buffer - Variable in class io.github.mmm.scanner.AbstractCharStreamScanner

The internal buffer with character data.

builder(StringBuilder) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

C

charAt(int) - Method in class io.github.mmm.scanner.CharSequenceScanner

CharEscapeHelper - Class in io.github.mmm.scanner

Simple static helper for dealing with escaped characters.

CharEscapeHelper() - Constructor for class io.github.mmm.scanner.CharEscapeHelper

CharReaderScanner - Class in io.github.mmm.scanner

Implementation of CharStreamScanner that adapts a Reader to read and parse textual data.

CharReaderScanner() - Constructor for class io.github.mmm.scanner.CharReaderScanner

The constructor.

CharReaderScanner(int) - Constructor for class io.github.mmm.scanner.CharReaderScanner

The constructor.

CharReaderScanner(int, Reader) - Constructor for class io.github.mmm.scanner.CharReaderScanner

The constructor.

CharReaderScanner(Reader) - Constructor for class io.github.mmm.scanner.CharReaderScanner

The constructor.

CharScannerParser<T> - Interface in io.github.mmm.scanner

Interface of a parser the can parse a Java object from a string representation.

CharScannerSyntax - Interface in io.github.mmm.scanner

This is the interface used to define the syntax to scan characters.

CharScannerSyntaxBean - Class in io.github.mmm.scanner

This is the implementation of CharScannerSyntax as Java bean.

CharScannerSyntaxBean() - Constructor for class io.github.mmm.scanner.CharScannerSyntaxBean

The constructor.

CharSequenceScanner - Class in io.github.mmm.scanner

This class represents a String or better a sequence of characters ( char[]) together with a position in that sequence.

CharSequenceScanner(char[]) - Constructor for class io.github.mmm.scanner.CharSequenceScanner

The constructor.

CharSequenceScanner(char[], int, int) - Constructor for class io.github.mmm.scanner.CharSequenceScanner

The constructor.

CharSequenceScanner(CharSequence) - Constructor for class io.github.mmm.scanner.CharSequenceScanner

The constructor.

CharSequenceScanner(String) - Constructor for class io.github.mmm.scanner.CharSequenceScanner

The constructor.

CharStreamScanner - Interface in io.github.mmm.scanner

This is the interface for a scanner that can be used to parse a stream or sequence of characters.

consumeDecimal() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

consumeDecimal() - Method in interface io.github.mmm.scanner.CharStreamScanner

Consumes the characters of a decimal number (double or float).

E

EOS - Static variable in interface io.github.mmm.scanner.CharStreamScanner

The NULL character '\0' used to indicate the end of stream (EOS).
ATTENTION: Do not confuse and mix '\0' with '0'.

eot(StringBuilder, boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

expectOne(char) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

expectOne(char) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method checks that the next character is equal to the given expected character.

expectOne(CharFilter) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

expectOne(CharFilter) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method checks that the next character is accepted by the given CharFilter.

expectRestWithLookahead(char[], boolean, Runnable, boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

expectRestWithLookahead(char[], boolean, Runnable, boolean) - Method in class io.github.mmm.scanner.CharReaderScanner

expectRestWithLookahead(char[], boolean, Runnable, boolean) - Method in class io.github.mmm.scanner.CharSequenceScanner

expectStrict(String) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method acts as expectUnsafe(String, boolean) but if the expected String is NOT completely present, no character is consumed and the state of the scanner remains unchanged.
Attention:
This method requires lookahead.

expectStrict(String, boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method acts as expectUnsafe(String, boolean) but if the expected String is NOT completely present, no character is consumed and the state of the scanner remains unchanged.
Attention:
This method requires lookahead.

expectStrict(String, boolean, boolean) - Method in class io.github.mmm.scanner.CharReaderScanner

expectStrict(String, boolean, boolean) - Method in class io.github.mmm.scanner.CharSequenceScanner

expectStrict(String, boolean, boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method acts as expectUnsafe(String, boolean) but if the expected String is NOT completely present, no character is consumed and the state of the scanner remains unchanged.
Attention:
This method requires lookahead.

expectUnsafe(String) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method skips all next characters as long as they equal to the according character of the expected string.

expectUnsafe(String, boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

expectUnsafe(String, boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method skips all next characters as long as they equal to the according character of the expected string.

F

fill() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

Fills the internal AbstractCharStreamScanner.buffer with further data (if available from underlying source such as a stream/reader).

fill() - Method in class io.github.mmm.scanner.CharReaderScanner

G

getAltQuoteEnd() - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method gets the alternative character used to end a quotation.

getAltQuoteEnd() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

This method gets the alternative character used to end a quotation.

getAltQuoteEscape() - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method gets the character used to escape the alt-quote-end character within an quotation opened by alt-quote-start.

getAltQuoteEscape() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

getAltQuoteStart() - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method gets the alternative character used to start a quotation that should be terminated by a alt-quote-end character.

getAltQuoteStart() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

This method gets the alternative character used to start a quotation that should be terminated by a alt-quote-end character.

getAppended(StringBuilder, int, int) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

getBufferParsed() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

getBufferParsed() - Method in interface io.github.mmm.scanner.CharStreamScanner

getBufferToParse() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

getBufferToParse() - Method in interface io.github.mmm.scanner.CharStreamScanner

getCurrentIndex() - Method in class io.github.mmm.scanner.CharSequenceScanner

This method gets the current position in the stream to scan.

getEntityEnd() - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method gets the character used to end an entity.

getEntityEnd() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

getEntityStart() - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method gets the character used to start an entity.

getEntityStart() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

getEscape() - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method gets the character used as escape.

getEscape() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

getLength() - Method in class io.github.mmm.scanner.CharSequenceScanner

getOriginalString() - Method in class io.github.mmm.scanner.CharSequenceScanner

This method gets the original string to parse.

getPosition() - Method in class io.github.mmm.scanner.CharReaderScanner

getPosition() - Method in class io.github.mmm.scanner.CharSequenceScanner

getPosition() - Method in interface io.github.mmm.scanner.CharStreamScanner

getQuoteEnd() - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method gets the character used to end a quotation.

getQuoteEnd() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

getQuoteEscape() - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method gets the character used to escape the quote-end character within a quotation.

getQuoteEscape() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

getQuoteStart() - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method gets the character used to start a quotation that should be terminated by a quote-end character.

getQuoteStart() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

getReplaced(String, int, int) - Method in class io.github.mmm.scanner.CharSequenceScanner

This method gets the original string where the substring specified by start and end is replaced by substitute.

getTail() - Method in class io.github.mmm.scanner.CharSequenceScanner

This method gets the tail of this scanner without changing the state.

getTail(int) - Method in class io.github.mmm.scanner.CharSequenceScanner

This method gets the tail of this scanner limited (truncated) to the given maximum number of characters without changing the state.

H

hasNext() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

hasNext() - Method in class io.github.mmm.scanner.CharSequenceScanner

hasNext() - Method in interface io.github.mmm.scanner.CharStreamScanner

This method determines if there is at least one more character available.

I

io.github.mmm.scanner - module io.github.mmm.scanner

Provides scanners that help to parse character sequences efficient and easily.

io.github.mmm.scanner - package io.github.mmm.scanner

Provides the API for scanners that help to parse character sequences efficient and easily.

isAltQuoteEscapeLazy() - Method in interface io.github.mmm.scanner.CharScannerSyntax

If alt-quote-start, alt-quote-end and alt-quote-escape all point to the same character (which is NOT '\0'), then this method determines if alt-quotation escaping is lazy.

isAltQuoteEscapeLazy() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

isEob() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

isEob() - Method in class io.github.mmm.scanner.CharReaderScanner

isEos() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

isEos() - Method in class io.github.mmm.scanner.CharReaderScanner

isEot() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

ATTENTION:

isEot() - Method in class io.github.mmm.scanner.CharReaderScanner

isQuoteEscapeLazy() - Method in interface io.github.mmm.scanner.CharScannerSyntax

If quote-start, quote-end and quote-escape all point to the same character (which is NOT '\0'), then this method determines if quotation escaping is lazy.

isQuoteEscapeLazy() - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

L

limit - Variable in class io.github.mmm.scanner.AbstractCharStreamScanner

The limit in the AbstractCharStreamScanner.buffer.

N

next() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

next() - Method in class io.github.mmm.scanner.CharSequenceScanner

next() - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads the current character from the stream and increments the index stepping to the next character.

O

offset - Variable in class io.github.mmm.scanner.AbstractCharStreamScanner

The start position in the AbstractCharStreamScanner.buffer from where reading operations consumer data from.

P

parse(CharStreamScanner) - Method in interface io.github.mmm.scanner.CharScannerParser

parse(Reader) - Method in interface io.github.mmm.scanner.CharScannerParser

parse(String) - Method in interface io.github.mmm.scanner.CharScannerParser

peek() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

peek() - Method in class io.github.mmm.scanner.CharSequenceScanner

peek() - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads the current character without incrementing the index.

peek(int) - Method in class io.github.mmm.scanner.CharSequenceScanner

This method peeks the number of next characters given by count and returns them as string.

position - Variable in class io.github.mmm.scanner.CharReaderScanner

R

read(int) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

read(int) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads the number of next characters given by count and returns them as string.

readDigit() - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads the next character if it is a digit.

readDigit(int) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readDigit(int) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads the next character if it is a digit within the given radix.

readDouble() - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads the double value (decimal number) starting at the current position by reading as many matching characters as available and returns its parsed value.

readFloat() - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads the float value (decimal number) starting at the current position by reading as many matching characters as available and returns its parsed value.

readJavaCharLiteral() - Method in interface io.github.mmm.scanner.CharStreamScanner

Reads and parses a Java Character literal value according to JLS 3.10.6.

readJavaCharLiteral(boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readJavaCharLiteral(boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

Reads and parses a Java Character literal value according to JLS 3.10.6.

readJavaStringLiteral() - Method in interface io.github.mmm.scanner.CharStreamScanner

Reads and parses a Java String literal value according to JLS 3.10.6.

readJavaStringLiteral(boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readJavaStringLiteral(boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

Reads and parses a Java String literal value according to JLS 3.10.6.

readLine() - Method in interface io.github.mmm.scanner.CharStreamScanner

readLine(boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readLine(boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

readLong(int) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readLong(int) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads the long starting at the current position by reading as many Latin digits as available but at maximum the given maxDigits and returns its parsed value.

readUntil(char, boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readUntil(char, boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the given stop character or the end is reached.

readUntil(char, boolean, char) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readUntil(char, boolean, char) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the given (un-escaped) stop character or the end is reached.

readUntil(char, boolean, CharScannerSyntax) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readUntil(char, boolean, CharScannerSyntax) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the given stop character or the end of the string to parse is reached.

readUntil(CharFilter, boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readUntil(CharFilter, boolean) - Method in class io.github.mmm.scanner.CharSequenceScanner

readUntil(CharFilter, boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the first character accepted by the given filter or the end is reached.

readUntil(CharFilter, boolean, CharScannerSyntax) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readUntil(CharFilter, boolean, CharScannerSyntax) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the given CharFilter accepts the current character as stop character or the end of data is reached.

readUntil(CharFilter, boolean, String) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the first character accepted by the given filter, the given stop String or the end is reached.

readUntil(CharFilter, boolean, String, boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the first character accepted by the given filter, the given stop String or the end is reached.

readUntil(CharFilter, boolean, String, boolean, boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readUntil(CharFilter, boolean, String, boolean, boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the first character accepted by the given filter, the given stop String or the end is reached.

readWhile(CharFilter) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters that are accepted by the given filter.

readWhile(CharFilter, int) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

readWhile(CharFilter, int) - Method in class io.github.mmm.scanner.CharSequenceScanner

readWhile(CharFilter, int) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters that are accepted by the given filter.

require(CharFilter, int) - Method in interface io.github.mmm.scanner.CharStreamScanner

require(CharFilter, int, int) - Method in interface io.github.mmm.scanner.CharStreamScanner

require(String, boolean) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

require(String, boolean) - Method in class io.github.mmm.scanner.CharSequenceScanner

require(String, boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method verifies that the expected string gets consumed from this scanner with respect to ignoreCase.

requireOne(char) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method verifies that the next character is equal to the given expected character.

requireOne(CharFilter) - Method in interface io.github.mmm.scanner.CharStreamScanner

requireOneOrMore(CharFilter) - Method in interface io.github.mmm.scanner.CharStreamScanner

reset() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

Resets the internal state.

resolveEntity(String) - Method in interface io.github.mmm.scanner.CharScannerSyntax

This method resolves the given entity.

resolveEntity(String) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

This method resolves the given entity.

resolveEscape(char) - Static method in class io.github.mmm.scanner.CharEscapeHelper

resolveEscape(String) - Static method in class io.github.mmm.scanner.CharEscapeHelper

S

setAltQuote(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

This method sets both the alt-quote-start and alt-quote-end character.

setAltQuoteEnd(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

This method sets the alt-quote-end character.

setAltQuoteEscape(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setAltQuoteEscapeLazy(boolean) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setAltQuoteStart(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setCurrentIndex(int) - Method in class io.github.mmm.scanner.CharSequenceScanner

This method sets the current index.

setEntityEnd(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setEntityStart(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setEscape(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setQuote(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

This method sets both the quote-start and quote-end character.

setQuoteEnd(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setQuoteEscape(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setQuoteEscapeLazy(boolean) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setQuoteStart(char) - Method in class io.github.mmm.scanner.CharScannerSyntaxBean

setReader(Reader) - Method in class io.github.mmm.scanner.CharReaderScanner

Resets this buffer for reuse with a new Reader.
This will also reset the position.

skip(int) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

skip(int) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method skips the number of next characters given by count.

skipOver(String) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the given substring has been detected.

skipOver(String, boolean) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the given substring has been detected.

skipOver(String, boolean, CharFilter) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

skipOver(String, boolean, CharFilter) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method consumes all next characters until the given substring has been detected, a character was accepted by the given CharFilter or the end of data was reached.
After the call of this method this scanner will point to the next character after the first occurrence of substring, to the stop character or to end of data.

skipUntil(char) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

skipUntil(char) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method skips all next characters until the given stop character or the end is reached.

skipUntil(char, char) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

skipUntil(char, char) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters until the given stop character or the end of the string to parse is reached.

skipWhile(char) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

skipWhile(char) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters that are identical to the character given by c.

skipWhile(CharFilter) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters that are accepted by the given filter.

skipWhile(CharFilter, int) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

skipWhile(CharFilter, int) - Method in interface io.github.mmm.scanner.CharStreamScanner

This method reads all next characters that are accepted by the given filter.

skipWhileAndPeek(CharFilter) - Method in interface io.github.mmm.scanner.CharStreamScanner

Behaves like the following code:

skipWhileAndPeek(CharFilter, int) - Method in interface io.github.mmm.scanner.CharStreamScanner

Behaves like the following code:

stepBack() - Method in class io.github.mmm.scanner.CharSequenceScanner

This method decrements the index by one.

substring(int, int) - Method in class io.github.mmm.scanner.CharSequenceScanner

T

toString() - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

V

verifyLookahead(String) - Method in class io.github.mmm.scanner.AbstractCharStreamScanner

verifyLookahead(String) - Method in class io.github.mmm.scanner.CharReaderScanner

A B C E F G H I L N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values