blue.endless.jankson.impl

Class CommentParserContext

java.lang.Object

blue.endless.jankson.impl.CommentParserContext

All Implemented Interfaces:

ParserContext<java.lang.String>

public class CommentParserContext
extends java.lang.Object
implements ParserContext<java.lang.String>

Constructor Summary

Constructors

Constructor and Description
CommentParserContext(int codePoint)

Method Summary

Modifier and Type	Method and Description
boolean	consume(int codePoint, Jankson loader) Consume one codepoint from the stream, and either use it to continue composing the result or to discover that the result is complete and processing should stop.
void	eof() Notifies this context that the file ended abruptly while in this context and before isComplete returned true.
java.lang.String	getResult() Gets the result of parsing.
boolean	isComplete() Returns true if the parser has assembled a complete result.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentParserContext

public CommentParserContext(int codePoint)

Method Detail

consume

public boolean consume(int codePoint,
                       Jankson loader)
                throws SyntaxError

Description copied from interface: ParserContext

Consume one codepoint from the stream, and either use it to continue composing the result or to discover that the result is complete and processing should stop. Throws a SyntaxError if unexpected or nonsense characters are encountered.

Specified by:

consume in interface ParserContext<java.lang.String>

Throws:

SyntaxError

eof

public void eof()
         throws SyntaxError

Description copied from interface: ParserContext

Notifies this context that the file ended abruptly while in this context and before isComplete returned true. In some contexts, like a single-line comment, this is fine. In most contexts, this should throw a descriptive error.

Specified by:

eof in interface ParserContext<java.lang.String>

Throws:

SyntaxError

isComplete

public boolean isComplete()

Description copied from interface: ParserContext

Returns true if the parser has assembled a complete result. After true is returned, no more code points will be offered to consume, and getResult will soon be called to retrieve the result.

Specified by:

isComplete in interface ParserContext<java.lang.String>

getResult

public java.lang.String getResult()
                           throws SyntaxError

Description copied from interface: ParserContext

Gets the result of parsing. Will be called only after isComplete reports true and processing of input has ceased.

Specified by:

getResult in interface ParserContext<java.lang.String>

Throws:

SyntaxError