org.springframework.xd.dirt.job.dsl

Class Tokens

java.lang.Object

org.springframework.xd.dirt.job.dsl.Tokens

public class Tokens
extends java.lang.Object

Class that converts an expression into a list of tokens. Furthermore, this class provides methods to process the tokens and keeps track of the current token being processed.

Author:

Andy Clement, Patrick Peralta

Constructor Summary

Constructors

Constructor and Description
Tokens(java.lang.String expression) Construct a Tokens object based on the provided string expression.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkpoint() Indicate that a piece of the DSL has been successfully processed.
protected int	decrementPosition() Decrement the current token position and return the new position.
protected Token	eat(TokenKind expectedKind) Consume the next token if it matches the indicated token kind; otherwise throw CheckpointedJobDefinitionException.
protected java.lang.String	getExpression() Return the expression string converted to tokens.
java.util.List<Token>	getTokenStream() Return an immutable list of tokens
protected boolean	hasNext() Return true if there are more tokens to process.
protected boolean	isNextAdjacent() Return true if the first character of the token at the current position is the same as the last character of the token at the previous position.
protected boolean	lookAhead(int distance, TokenKind desiredTokenKind) Return true if the token in the position indicated by position + distance matches the token indicated by desiredTokenKind.
protected boolean	maybeEat(TokenKind desiredKind) Consume the next token if it matches the desired token kind and return true; otherwise return false.
protected Token	next() Return the next Token and advance the current token position.
protected Token	peek() Return the token at the current position.
protected Token	peek(int offset) Return the token at the specified offset from the current position.
protected boolean	peek(int offset, TokenKind tokenKind) Peek at the token at an offset (relative to the current position) - if the token matches the indicated kind, return true, otherwise return false.
protected boolean	peek(TokenKind desiredTokenKind) Return true if the indicated token matches the current token position.
protected int	position() Return the current token position.
protected void	raiseException(int position, JobDSLMessage message, java.lang.Object... inserts) Throw a new CheckpointedJobDefinitionException based on the current and last successfully processed token position.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Tokens

public Tokens(java.lang.String expression)

Construct a Tokens object based on the provided string expression.

Parameters:

expression - string expression to convert into tokens.

Method Detail

getExpression

protected java.lang.String getExpression()

Return the expression string converted to tokens.

Returns:

expression string

decrementPosition

protected int decrementPosition()

Decrement the current token position and return the new position.

Returns:

new token position

position

protected int position()

Return the current token position.

Returns:

current token position

getTokenStream

public java.util.List<Token> getTokenStream()

Return an immutable list of tokens

Returns:

list of tokens

lookAhead

protected boolean lookAhead(int distance,
                TokenKind desiredTokenKind)

Return true if the token in the position indicated by position + distance matches the token indicated by desiredTokenKind.

Parameters:

distance - number of token positions past the current position

desiredTokenKind - the token to check for

Returns:

true if the token at the indicated position matches desiredTokenKind

hasNext

protected boolean hasNext()

Return true if there are more tokens to process.

Returns:

true if there are more tokens to process

peek

protected Token peek()

Return the token at the current position. If there are no more tokens, return null.

Returns:

token at current position or null if there are no more tokens

peek

protected Token peek(int offset)

Return the token at the specified offset from the current position. If there are no more tokens, return null.

Returns:

token at specified offset from current position or null if there are no more tokens

peek

protected boolean peek(int offset,
           TokenKind tokenKind)

Peek at the token at an offset (relative to the current position) - if the token matches the indicated kind, return true, otherwise return false.

Parameters:

offset - the offset from the current position to peek at

tokenKind - the tokenKind to check against

Returns:

true if the token at the specified offset matches the indicated kind, otherwise false

peek

protected boolean peek(TokenKind desiredTokenKind)

Return true if the indicated token matches the current token position.

Parameters:

desiredTokenKind - token to match

Returns:

true if the current token kind matches the provided token kind

next

protected Token next()

Return the next Token and advance the current token position.

Returns:

next Token

eat

protected Token eat(TokenKind expectedKind)

Consume the next token if it matches the indicated token kind; otherwise throw CheckpointedJobDefinitionException.

Parameters:

expectedKind - the expected token kind

Returns:

the next token

Throws:

CheckpointedJobDefinitionException - if the next token does not match the expected token kind

maybeEat

protected boolean maybeEat(TokenKind desiredKind)

Consume the next token if it matches the desired token kind and return true; otherwise return false.

Parameters:

desiredKind - the desired token to eat

Returns:

true if the token was consumed, otherwise false

isNextAdjacent

protected boolean isNextAdjacent()

Return true if the first character of the token at the current position is the same as the last character of the token at the previous position.

Returns:

true if the first character of the current token matches the last character of the previous token

checkpoint

protected void checkpoint()

Indicate that a piece of the DSL has been successfully processed.

See Also:

lastGoodPosition

raiseException

protected void raiseException(int position,
                  JobDSLMessage message,
                  java.lang.Object... inserts)

Throw a new CheckpointedJobDefinitionException based on the current and last successfully processed token position.

Parameters:

position - position where parse error occurred

message - parse exception message

inserts - variables that may be inserted in the error message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object