com.phoenix_int.aserver
Class PHXVariableInfo

java.lang.Object
  com.phoenix_int.aserver.PHXVariableInfo

public class PHXVariableInfo
extends java.lang.Object

this is a utility class for holding parsing information about a variable

Constructor Summary

PHXVariableInfo()
creates an unitialized object.

PHXVariableInfo(java.lang.String name, boolean input, java.lang.Object var)

Method Summary

java.lang.String	getName()
java.lang.String	getType()
java.lang.Object	getVariable()
void	initialize(java.lang.String name, boolean input, java.lang.Object var) initializes the variable
boolean	isInput()
void	setVariable(java.lang.Object var)

Methods inherited from class java.lang.Object

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

Constructor Detail

PHXVariableInfo

public PHXVariableInfo()

creates an unitialized object. Initialize must be called before any of the methods will work properly

PHXVariableInfo

public PHXVariableInfo(java.lang.String name,
                       boolean input,
                       java.lang.Object var)
                throws PHXInvalidNameException

Parameters:

name - the name of the variable

input - true if the variable is an input, false if an output

var - the actual variable

Throws:

PHXInvalidNameException - thrown if the name contains invalid characters

Method Detail

initialize

public void initialize(java.lang.String name,
                       boolean input,
                       java.lang.Object var)
                throws PHXInvalidNameException

initializes the variable

Parameters:

name - the name of the variable

input - true if the variable is an input, false if an output

var - the actual variable

Throws:

PHXInvalidNameException - thrown if the name contains invalid characters

getName

public java.lang.String getName()

isInput

public boolean isInput()

getVariable

public java.lang.Object getVariable()

setVariable

public void setVariable(java.lang.Object var)

getType

public java.lang.String getType()