org.eclipse.soda.dk.device.servlet
Class TemplateInputStream

java.lang.Object
  java.io.InputStream
      org.eclipse.soda.dk.device.servlet.TemplateInputStream

All Implemented Interfaces:

java.io.Closeable

public class TemplateInputStream
extends java.io.InputStream

Version:

1.0.0

See Also:

ByteArrayOutputStream, Vector

Field Summary

(package private) boolean	commentLine Define the comment line (boolean) field.
(package private) int	depth Define the depth (int) field.
(package private) boolean	entityRef Define the entity ref (boolean) field.

Constructor Summary

TemplateInputStream()
Constructs an DkSsiInputStream object using the input parameter(s).

TemplateInputStream(java.io.InputStream inputStream)
Constructs an DkSsiInputStream object using the input parameter(s).

Method Summary

void	addEntity(java.lang.String key, java.lang.String value) Add entity with the specified key and value parameters.
void	addVariable(java.lang.String key, java.lang.String value) Add variable with the specified key and value parameters.
boolean	expr(java.lang.String variableName) Expr with the specified variable name parameter and return the boolean result.
java.io.InputStream	getBlankStream() Gets the blank stream (InputStream) value.
java.io.InputStream	getEchoVar(java.lang.String variableName) Perform the getEchoVar method and return the InputStream result.
java.util.Hashtable	getEntities() Gets the entities (Hashtable) value.
java.lang.String	getEntity(java.lang.String key) Get entity with the specified key parameter and return the String result.
java.io.InputStream	getIncludeFile(java.lang.String value) Perform the getIncludeFile method and return the InputStream result.
java.io.InputStream	getIncludeVirtual(java.lang.String value) Perform the getIncludeVirtual method and return the InputStream result.
java.io.InputStream	getInputStream() Gets the InputStream inputStream property value.
java.util.ArrayList	getStack() Gets the ArrayList stack property value.
java.io.InputStream	getStream(java.lang.String commentLine) Perform the getStream method and return the InputStream result.
java.lang.String	getVariable(java.lang.String key) Get variable with the specified key parameter and return the String result.
java.util.Hashtable	getVariables() Gets the variables (Hashtable) value.
void	initializeVariables() Initialize variables.
java.io.InputStream	pop() Perform the pop method and return the InputStream result.
java.io.InputStream	processComment(java.lang.String comment) Perform the processComment method and return the InputStream result.
java.io.InputStream	processElse(java.lang.String variableName) Process else with the specified variable name parameter and return the InputStream result.
java.io.InputStream	processEndif(java.lang.String variableName) Process endif with the specified variable name parameter and return the InputStream result.
java.io.InputStream	processEntityReference(java.lang.String comment) Process entity reference with the specified comment parameter and return the InputStream result.
java.io.InputStream	processIf(java.lang.String variableName) Process if with the specified variable name parameter and return the InputStream result.
java.io.InputStream	processSsiCommand(java.lang.String command, java.lang.String tag, java.lang.String value) Perform the processSsiCommand method and return the InputStream result.
java.io.InputStream	processSsiLogicCommand(java.lang.String command, java.lang.String tag, java.lang.String value) Process ssi logic command with the specified command, tagAsVersion and value parameters and return the InputStream result.
void	push(java.io.InputStream inputStream) Perform the push action method.
int	read() Perform the read method and return the int result.
java.io.InputStream	setEchoVar(java.lang.String variableName) Sets the echo var value.
void	setEntities(java.util.Hashtable entities) Sets the entities value.
void	setVariables(java.util.Hashtable variables) Sets the variables value.

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object

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

Field Detail

depth

int depth

Define the depth (int) field.

commentLine

boolean commentLine

Define the comment line (boolean) field.

entityRef

boolean entityRef

Define the entity ref (boolean) field.

Constructor Detail

TemplateInputStream

public TemplateInputStream()

Constructs an DkSsiInputStream object using the input parameter(s).

Parameters:

inputStream - java.io.InputStream

See Also:

TemplateInputStream(InputStream)

TemplateInputStream

public TemplateInputStream(java.io.InputStream inputStream)

Constructs an DkSsiInputStream object using the input parameter(s).

Parameters:

inputStream - java.io.InputStream

See Also:

TemplateInputStream()

Method Detail

addEntity

public void addEntity(java.lang.String key,
                      java.lang.String value)

Add entity with the specified key and value parameters.

Parameters:

key - The key (String) parameter.

value - The value (String) parameter.

See Also:

getEntity(String)

addVariable

public void addVariable(java.lang.String key,
                        java.lang.String value)

Add variable with the specified key and value parameters.

Parameters:

key - The key (String) parameter.

value - The value (String) parameter.

See Also:

getVariable(String)

expr

public boolean expr(java.lang.String variableName)

Expr with the specified variable name parameter and return the boolean result.

Parameters:

variableName - The variable name (String) parameter.

Returns:

Results of the expr (boolean) value.

getBlankStream

public java.io.InputStream getBlankStream()

Gets the blank stream (InputStream) value.

Returns:

The blank stream (InputStream) value.

getEchoVar

public java.io.InputStream getEchoVar(java.lang.String variableName)

Perform the getEchoVar method and return the InputStream result.

Parameters:

value - java.lang.String

variableName - The variable name (String) parameter.

Returns:

Results of the get echo var (InputStream) value.

See Also:

setEchoVar(String)

getEntities

public java.util.Hashtable getEntities()

Gets the entities (Hashtable) value.

Returns:

The entities (Hashtable) value.

See Also:

setEntities(Hashtable)

getEntity

public java.lang.String getEntity(java.lang.String key)

Get entity with the specified key parameter and return the String result.

Parameters:

key - The key (String) parameter.

Returns:

Results of the get entity (String) value.

See Also:

addEntity(String,String)

getIncludeFile

public java.io.InputStream getIncludeFile(java.lang.String value)

Perform the getIncludeFile method and return the InputStream result.

Parameters:

value - java.lang.String

Returns:

Results of the get include file (InputStream) value.

getIncludeVirtual

public java.io.InputStream getIncludeVirtual(java.lang.String value)

Perform the getIncludeVirtual method and return the InputStream result.

Parameters:

value - java.lang.String

Returns:

Results of the get include virtual (InputStream) value.

getInputStream

public java.io.InputStream getInputStream()

Gets the InputStream inputStream property value.

Returns:

Results of the get input stream (InputStream) value.

See Also:

TemplateInputStream(), TemplateInputStream(InputStream)

getStack

public java.util.ArrayList getStack()

Gets the ArrayList stack property value.

Returns:

Results of the get stack (ArrayList) value.

getStream

public java.io.InputStream getStream(java.lang.String commentLine)

Perform the getStream method and return the InputStream result.

Parameters:

commentLine - java.lang.String

Returns:

Results of the get stream (InputStream) value.

See Also:

TemplateInputStream(), TemplateInputStream(InputStream), getBlankStream(), getInputStream()

getVariable

public java.lang.String getVariable(java.lang.String key)

Get variable with the specified key parameter and return the String result.

Parameters:

key - The key (String) parameter.

Returns:

Results of the get variable (String) value.

See Also:

addVariable(String,String)

getVariables

public java.util.Hashtable getVariables()

Gets the variables (Hashtable) value.

Returns:

The variables (Hashtable) value.

See Also:

initializeVariables(), setVariables(Hashtable)

initializeVariables

public void initializeVariables()

Initialize variables.

See Also:

getVariables(), setVariables(Hashtable)

pop

public java.io.InputStream pop()

Perform the pop method and return the InputStream result.

Returns:

Results of the pop (InputStream) value.

processComment

public java.io.InputStream processComment(java.lang.String comment)

Perform the processComment method and return the InputStream result.

Parameters:

comment - java.lang.String

Returns:

Results of the process comment (InputStream) value.

processElse

public java.io.InputStream processElse(java.lang.String variableName)

Process else with the specified variable name parameter and return the InputStream result.

Parameters:

variableName - The variable name (String) parameter.

Returns:

Results of the process else (InputStream) value.

processEndif

public java.io.InputStream processEndif(java.lang.String variableName)

Process endif with the specified variable name parameter and return the InputStream result.

Parameters:

variableName - The variable name (String) parameter.

Returns:

Results of the process endif (InputStream) value.

processEntityReference

public java.io.InputStream processEntityReference(java.lang.String comment)

Process entity reference with the specified comment parameter and return the InputStream result.

Parameters:

comment - The comment (String) parameter.

Returns:

Results of the process entity reference (InputStream) value.

processIf

public java.io.InputStream processIf(java.lang.String variableName)

Process if with the specified variable name parameter and return the InputStream result.

Parameters:

variableName - The variable name (String) parameter.

Returns:

Results of the process if (InputStream) value.

processSsiCommand

public java.io.InputStream processSsiCommand(java.lang.String command,
                                             java.lang.String tag,
                                             java.lang.String value)

Perform the processSsiCommand method and return the InputStream result.

Parameters:

command - java.lang.String

tagAsVersion - java.lang.String

value - java.lang.String

tag - The tag (String) parameter.

Returns:

Results of the process ssi command (InputStream) value.

processSsiLogicCommand

public java.io.InputStream processSsiLogicCommand(java.lang.String command,
                                                  java.lang.String tag,
                                                  java.lang.String value)

Process ssi logic command with the specified command, tagAsVersion and value parameters and return the InputStream result.

Parameters:

command - The command (String) parameter.

tagAsVersion - The tagAsVersion (String) parameter.

value - The value (String) parameter.

tag - The tag (String) parameter.

Returns:

Results of the process ssi logic command (InputStream) value.

push

public void push(java.io.InputStream inputStream)

Perform the push action method.

Parameters:

inputStream - java.io.InputStream

read

public int read()
         throws java.io.IOException

Perform the read method and return the int result.

Specified by:

read in class java.io.InputStream

Returns:

Results of the read (int) value.

Throws:

- href="java.io.IOException.html">IOException Thrown if the IOException exception condition occurs.

IOException.

java.io.IOException

setEchoVar

public java.io.InputStream setEchoVar(java.lang.String variableName)

Sets the echo var value.

Parameters:

variableName - The variable name (String) parameter.

Returns:

The echo var (InputStream) value.

See Also:

getEchoVar(String)

setEntities

public void setEntities(java.util.Hashtable entities)

Sets the entities value.

Parameters:

entities - The entities (Hashtable) parameter.

See Also:

getEntities()

setVariables

public void setVariables(java.util.Hashtable variables)

Sets the variables value.

Parameters:

variables - The variables (Hashtable) parameter.

See Also:

getVariables(), initializeVariables()