com.mmnaseri.utils.spring.data.string

Interface DocumentReader

All Known Implementing Classes:

DefaultDocumentReader

public interface DocumentReader

Since:

1.0 (9/19/15)

Author:

Milad Naseri (m.m.naseri@gmail.com)

Method Summary

Modifier and Type	Method and Description
void	backtrack(int count) Moves back the specified number of characters
String	expect(Pattern pattern) This will attempt to read string matching the given pattern from the document at the current point indicated by the cursor.
String	expect(String pattern) This will attempt to read string matching the given pattern from the document at the current point indicated by the cursor.
boolean	has(Pattern pattern) This method will determine whether the indicated pattern can be found at this point in the document or not
boolean	has(String pattern) This method will determine whether the indicated pattern can be found at this point in the document or not
boolean	hasMore() Determines whether we have hit the end of the document or not
String	read(Pattern pattern) Will attempt to read the string matching the given parameter.
String	read(String pattern) Will attempt to read the string matching the given parameter.
void	reset() This will cause the state of the reading to be reset.
String	rest() This will return the parts of document not yet read through by the reader

Method Detail

rest

String rest()

This will return the parts of document not yet read through by the reader

Returns:

the part of the document not processed by the reader

has

boolean has(Pattern pattern)

This method will determine whether the indicated pattern can be found at this point in the document or not

Parameters:

pattern - the lookup pattern

Returns:

true if the pattern can be found

has

boolean has(String pattern)

This method will determine whether the indicated pattern can be found at this point in the document or not

Parameters:

pattern - the lookup pattern

Returns:

true if the pattern can be found

hasMore

boolean hasMore()

Determines whether we have hit the end of the document or not

Returns:

true if we have no more to go

read

String read(Pattern pattern)

Will attempt to read the string matching the given parameter. If the string matched with this pattern does not start at the current point in the document, the result will be considered to be negative.

Parameters:

pattern - the compiled pattern to be matched against

Returns:

the string read by the method, or null if it cannot be found

See Also:

Pattern.compile(String), Pattern.compile(String, int)

read

String read(String pattern)

Will attempt to read the string matching the given parameter. If the string matched with this pattern does not start at the current point in the document, the result will be considered to be negative.

Parameters:

pattern - the compiled pattern to be matched against

Returns:

the string read by the method, or null if it cannot be found

See Also:

Pattern.compile(String), Pattern.compile(String, int)

expect

String expect(Pattern pattern)

This will attempt to read string matching the given pattern from the document at the current point indicated by the cursor. If failed to do so, the method will be expected to throw an exception or take corrective measures.

Parameters:

pattern - the regular to query for

Returns:

the read string

expect

String expect(String pattern)

This will attempt to read string matching the given pattern from the document at the current point indicated by the cursor. If failed to do so, the method will be expected to throw an exception or take corrective measures.

Parameters:

pattern - the regular to query for

Returns:

the read string

reset

void reset()

This will cause the state of the reading to be reset. The cursor will be set back to the beginning of the document, and the line/column positioning data will be reset to their initial value.

backtrack

void backtrack(int count)

Moves back the specified number of characters

Parameters:

count - character count to backtrack by