com.jiowa.template.token.variable

Class VariableToken

java.lang.Object

com.jiowa.template.token.Token

com.jiowa.template.token.ChangeableToken

com.jiowa.template.token.variable.VariableToken

All Implemented Interfaces:

java.lang.Comparable<Token>

public class VariableToken
extends ChangeableToken

This class contains information about a variable: its name and some operators to be applied to its string value. Operators can be: the change to lower case characters, upper case characters, changing all spaces to underscore characters etc.

Author:

Robert Mencl

Copyright (C) 2012 JIOWA Business Solutions GmbH, Bettinastr. 30 , 60325 Frankfurt am Main, Germany
Homepage: www.jiowa.de
All rights reserved.

Download: www.jiowa.de/download.html
License: www.jiowa.de/license.html

Field Summary

Fields

Modifier and Type	Field and Description
protected VariableOperatorList	operators List of operators that have been encoded in the variable string during the parsing process.

Fields inherited from class com.jiowa.template.token.ChangeableToken

original

Fields inherited from class com.jiowa.template.token.Token

position, text

Constructor Summary

Constructors

Constructor and Description
VariableToken(java.lang.String name, java.lang.String original, VariableOperatorList operators, TextPosition position) Constructor for variable tokens Hint: Parsing is done via VariableParser to create instances of VariableToken.
VariableToken(VariableToken token)
VariableToken(VariableToken token, int leftOffsetToBeAdded) Copy constructor with new textposition information.

Method Summary

Modifier and Type	Method and Description
java.lang.String	applyOperators(java.lang.String s)
java.util.List<VariableOperator>	getOperators()
java.lang.String	toString()

Methods inherited from class com.jiowa.template.token.ChangeableToken

getOriginal

Methods inherited from class com.jiowa.template.token.Token

compareTo, getText, getTextPosition, update

Methods inherited from class java.lang.Object

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

Field Detail

operators

protected VariableOperatorList operators

List of operators that have been encoded in the variable string during the parsing process.

Constructor Detail

VariableToken

public VariableToken(java.lang.String name,
                     java.lang.String original,
                     VariableOperatorList operators,
                     TextPosition position)

Constructor for variable tokens Hint: Parsing is done via VariableParser to create instances of VariableToken.

Parameters:

name - effective variable name

original - original unmodified text containing the variable name ( inclusive operators and superfluous white spaces ).

operators - parsed variable operators

position - text position of this variable token within the template.

VariableToken

public VariableToken(VariableToken token)

VariableToken

public VariableToken(VariableToken token,
                     int leftOffsetToBeAdded)

Copy constructor with new textposition information.

Parameters:

token - the variable token

leftOffsetToBeAdded - left offset

Method Detail

getOperators

public java.util.List<VariableOperator> getOperators()

applyOperators

public java.lang.String applyOperators(java.lang.String s)

toString

public java.lang.String toString()

Overrides:

toString in class Token