Package com.igormaznitsa.jcp.context

Class JCPSpecialVariableProcessor

java.lang.Object

com.igormaznitsa.jcp.context.JCPSpecialVariableProcessor

All Implemented Interfaces:

SpecialVariableProcessor

public class JCPSpecialVariableProcessor
extends Object
implements SpecialVariableProcessor

The class implements the special variable processor interface and allows to get access to inside JCP variables Inside JCP variables have the "jcp." prefix

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JCPSpecialVariableProcessor.NameReferencePair

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final SimpleDateFormat	dateFormat
(package private) final SimpleDateFormat	timeFormat
(package private) final SimpleDateFormat	timestampFormat
static final String	VAR_DATE
static final String	VAR_DEST_DIR
static final String	VAR_DEST_FILE_NAME
static final String	VAR_DEST_FULLPATH
static final String	VAR_LINE
static final String	VAR_SRC_DIR
static final String	VAR_SRC_DIR2
static final String	VAR_SRC_FILE_NAME
static final String	VAR_SRC_FILE_NAME2
static final String	VAR_SRC_FULLPATH
static final String	VAR_SRC_FULLPATH2
static final String	VAR_TIME
static final String	VAR_TIMESTAMP
static final String	VAR_VERSION

Constructor Summary

Constructors

Constructor	Description
JCPSpecialVariableProcessor()

Method Summary

Modifier and Type	Method	Description
static List<JCPSpecialVariableProcessor.NameReferencePair>	getReference()
Value	getVariable(String varName, PreprocessorContext context)	Get the value for the variable
String[]	getVariableNames()	Get all variable names allowed by the processor as an array, all names must be in lower case
void	setVariable(String varName, Value value, PreprocessorContext context)	Set a value to the variable

Methods inherited from class java.lang.Object

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

Field Details

VAR_DEST_DIR

public static final String VAR_DEST_DIR

See Also:

• Constant Field Values

VAR_VERSION

public static final String VAR_VERSION

See Also:

• Constant Field Values

VAR_DEST_FILE_NAME

public static final String VAR_DEST_FILE_NAME

See Also:

• Constant Field Values

VAR_DEST_FULLPATH

public static final String VAR_DEST_FULLPATH

See Also:

• Constant Field Values

VAR_SRC_FILE_NAME

public static final String VAR_SRC_FILE_NAME

See Also:

• Constant Field Values

VAR_SRC_FILE_NAME2

public static final String VAR_SRC_FILE_NAME2

See Also:

• Constant Field Values

VAR_SRC_DIR

public static final String VAR_SRC_DIR

See Also:

• Constant Field Values

VAR_SRC_DIR2

public static final String VAR_SRC_DIR2

See Also:

• Constant Field Values

VAR_SRC_FULLPATH

public static final String VAR_SRC_FULLPATH

See Also:

• Constant Field Values

VAR_SRC_FULLPATH2

public static final String VAR_SRC_FULLPATH2

See Also:

• Constant Field Values

VAR_LINE

public static final String VAR_LINE

See Also:

• Constant Field Values

VAR_DATE

public static final String VAR_DATE

See Also:

• Constant Field Values

VAR_TIME

public static final String VAR_TIME

See Also:

• Constant Field Values

VAR_TIMESTAMP

public static final String VAR_TIMESTAMP

See Also:

• Constant Field Values

dateFormat

final SimpleDateFormat dateFormat

timeFormat

final SimpleDateFormat timeFormat

timestampFormat

final SimpleDateFormat timestampFormat

Constructor Details

JCPSpecialVariableProcessor

public JCPSpecialVariableProcessor()

Method Details

getReference

@MustNotContainNull
public static List<JCPSpecialVariableProcessor.NameReferencePair> getReference()

getVariableNames

@MustNotContainNull
public String[] getVariableNames()

Description copied from interface: SpecialVariableProcessor

Get all variable names allowed by the processor as an array, all names must be in lower case

Specified by:

getVariableNames in interface SpecialVariableProcessor

Returns:

allowed variable names as a String array

getVariable

public Value getVariable(String varName,
 PreprocessorContext context)

Description copied from interface: SpecialVariableProcessor

Get the value for the variable

Specified by:

getVariable in interface SpecialVariableProcessor

Parameters:

varName - the variable name, must not be null

context - the preprocessor context, it can be null

Returns:

the value, it must not return null because it will notified preprocessor that it supports the variable

setVariable

public void setVariable(String varName,
 Value value,
 PreprocessorContext context)

Description copied from interface: SpecialVariableProcessor

Set a value to the variable

Specified by:

setVariable in interface SpecialVariableProcessor

Parameters:

varName - the variable name, must not be null

value - the value to be set to the variable, must not be null

context - the preprocessor context, it can be null