|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.flagstone.transform.FSTransformObject
com.flagstone.transform.FSRegisterVariable
public class FSRegisterVariable
FSRegisterVariable is a lightweight class used to identify the register that an argument defined in The FSNewFunction2 class is mapped into when executing the function.
Register numbers up to 255 may be specified. If the number is zero then the argument is defined as a local variable.
Constructor Summary | |
---|---|
FSRegisterVariable(FSCoder coder)
Construct an FSRegisterVariable object, initialising it with values decoded from an encoded object. |
|
FSRegisterVariable(FSRegisterVariable obj)
Constructs an FSRegisterVariable object by copying values from an existing object. |
|
FSRegisterVariable(int index,
java.lang.String name)
Constructs a new FSRegisterVariable object specifying the name of the argument and the number of the register it will be mapped to. |
Method Summary | |
---|---|
void |
appendDescription(java.lang.StringBuffer buffer,
int depth)
AppendDescription is used to present a string description of the object including all nested objects up to a specified depth. |
void |
decode(FSCoder coder)
|
void |
encode(FSCoder coder)
|
boolean |
equals(java.lang.Object anObject)
Returns true if anObject is equal to this one. |
int |
getIndex()
Gets the number of the register that will contain the function argument. |
java.lang.String |
getName()
Gets the name of the function argument. |
int |
length(FSCoder coder)
|
void |
setIndex(int index)
Sets the number of the register that will contain the function argument. |
void |
setName(java.lang.String name)
Sets the name of the function argument. |
Methods inherited from class com.flagstone.transform.FSTransformObject |
---|
clone, name, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FSRegisterVariable(FSCoder coder)
coder
- an FSCoder containing the binary data.public FSRegisterVariable(int index, java.lang.String name)
index
- the number of the register, 1..255, 0 if the argument will be
stored in a local variable.name
- the name of the argument.public FSRegisterVariable(FSRegisterVariable obj)
obj
- an FSRegisterVariable object.Method Detail |
---|
public int getIndex()
public java.lang.String getName()
public void setIndex(int index)
index
- the number of the register, 1..255, in which the function
argument will be stored, 0 if the argument will be stored in a
local variable.public void setName(java.lang.String name)
name
- the name of the argument.public boolean equals(java.lang.Object anObject)
equals
in class FSTransformObject
public void appendDescription(java.lang.StringBuffer buffer, int depth)
FSTransformObject
appendDescription
in class FSTransformObject
buffer
- a StringBuffer to which the description of each object is
appended.depth
- the maximum level of nesting up to which objects will be
displayed.public int length(FSCoder coder)
length
in class FSTransformObject
public void encode(FSCoder coder)
encode
in class FSTransformObject
public void decode(FSCoder coder)
decode
in class FSTransformObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |