com.mmnaseri.utils.spring.data.string.impl

Class DefaultDocumentReader

java.lang.Object

com.mmnaseri.utils.spring.data.string.impl.DefaultDocumentReader

All Implemented Interfaces:

DocumentReader

public class DefaultDocumentReader
extends Object
implements DocumentReader

Since:

1.0 (9/19/15)

Author:

Milad Naseri (mmnaseri@programmer.net)

Constructor Summary

Constructors

Constructor and Description
DefaultDocumentReader(String document) Instantiates the reader while taking in the document to be read through

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDocumentReader

public DefaultDocumentReader(String document)

Instantiates the reader while taking in the document to be read through

Parameters:

document - the document

Method Detail

rest

public String rest()

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

Specified by:

rest in interface DocumentReader

Returns:

the part of the document not processed by the reader

has

public boolean has(Pattern pattern)

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

Specified by:

has in interface DocumentReader

Parameters:

pattern - the lookup pattern

Returns:

true if the pattern can be found

has

public boolean has(String pattern)

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

Specified by:

has in interface DocumentReader

Parameters:

pattern - the lookup pattern

Returns:

true if the pattern can be found

hasMore

public boolean hasMore()

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

Specified by:

hasMore in interface DocumentReader

Returns:

true if we have no more to go

read

public 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.

Specified by:

read in interface DocumentReader

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

public 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.

Specified by:

read in interface DocumentReader

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

public 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.

Specified by:

expect in interface DocumentReader

Parameters:

pattern - the regular to query for

Returns:

the read string

expect

public String expect(String pattern)

Description copied from interface: DocumentReader

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.

Specified by:

expect in interface DocumentReader

Parameters:

pattern - the regular to query for

Returns:

the read string

reset

public 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.

Specified by:

reset in interface DocumentReader

backtrack

public void backtrack(int count)

Moves back the specified number of characters

Specified by:

backtrack in interface DocumentReader

Parameters:

count - character count to backtrack by