|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.data.AbleLiteral | +--com.ibm.able.data.AbleByteLiteral
This class wraps a value of the primitive type byte in an object. An object of type AbleByteLiteral contains a single, immutable field whose type is byte. Instances of AbleByteLiteral are used by the Able rules classes in clauses and expressions. In addition, this class provides methods for converting a byte to a String value as well as other logical comparison and math operator methods useful when dealing with a byte.
Field Summary | |
---|---|
protected byte |
myValue
The immutable value of this literal. |
Constructor Summary | |
---|---|
AbleByteLiteral(byte theValue)
Create a new literal with the specified value. |
|
AbleByteLiteral(int theValue)
Create a new literal with the specified value. |
Method Summary | |
---|---|
java.lang.String |
arlCRdString()
Return a formal ARL "clause read" string that describes this data object. |
AbleLiteral |
bitwiseAND(AbleRd theRhs)
Bitwise AND the current value of this data object with the current value of theRhs. |
AbleLiteral |
bitwiseNOT(AbleRd theRhs)
Bitwise NOT: complement the current value of this data object. |
AbleLiteral |
bitwiseOR(AbleRd theRhs)
Bitwise OR the current value of this data object with the current value of theRhs. |
AbleLiteral |
bitwiseShiftLeft(AbleRd theRhs)
Bitwise Shift Left the current value of this data object by the current value of theRhs. |
AbleLiteral |
bitwiseShiftRight(AbleRd theRhs)
Bitwise Shift Right the current value of this data object by the current value of theRhs. |
AbleLiteral |
bitwiseShiftRightZeroFill(AbleRd theRhs)
Bitwise Shift Right with Zero Fill the current value of this data object by the current value of theRhs. |
AbleLiteral |
bitwiseXOR(AbleRd theRhs)
Bitwise XOR: exclusive OR the current value of this data object with the current value of theRhs. |
boolean |
cmpEq(AbleRd theRhs)
Comparison, equal to: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpGt(AbleRd theRhs)
Comparison, greater than: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpGtEq(AbleRd theRhs)
Comparison, greater than or equal to: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpLt(AbleRd theRhs)
Comparison, less than: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpLtEq(AbleRd theRhs)
Comparison, less than or equal to: compare the current value of this data object to the current value of theRhs. |
boolean |
cmpNeq(AbleRd theRhs)
Comparison, not equal to: compare the current value of this data object to the current value of theRhs. |
AbleLiteral |
compDivide(AbleRd theRhs)
Compute, divide the current value of this data object by the current value of theRhs. |
AbleLiteral |
compMinus(AbleRd theRhs)
Compute, subtract the current value of theRhs from the current value of this object. |
AbleLiteral |
compModulo(AbleRd theRhs)
Compute, modulo - divide (without remainder) the current int value of this data object by the current value of theRhs. |
AbleLiteral |
compMultiply(AbleRd theRhs)
Compute, multiply the current value of this data object to the current value of theRhs. |
AbleLiteral |
compPlus(AbleRd theRhs)
Compute, add or concatenate the current value of this data object to the current value of theRhs. |
AbleLiteral |
compUnaryMinus(AbleRd theRhs)
Compute, the unary minus of the current value of this object. |
boolean |
equals(java.lang.Object theOtherObject)
|
boolean |
getBooleanValue()
Retrieve the value of this data object as a boolean value. |
int |
getDataType()
Retrieve the data type of this data object. |
java.lang.Class |
getDataTypeClass()
Retrieve the actual class of this object's underlying data type. |
java.lang.String |
getDataTypeClassName()
Retrieve the name of the class of this object's underlying data type. |
AbleFuzzySet |
getFuzzyValue()
Retrieve the value of this data object as a fuzzy value. |
java.lang.Object |
getGenericValue()
Retrieve the value of this data object as an Object. |
double |
getNumericValue()
Retrieve the value of this data object as a numeric value. |
java.lang.String |
getStringValue()
Retrieve the value of this data object as a string value. |
AbleLiteral |
getValue()
Retrieve the value of this data object as a literal. |
java.lang.String |
toString()
Retrieve a string describing (the contents of) the object. |
java.lang.String |
traceString(int theTraceStringFlavor)
Retrieve a string describing (the contents of) the object. |
java.lang.String |
xmlCRdString()
Return a formal XML "clause read" string that describes this data object. |
Methods inherited from class com.ibm.able.data.AbleLiteral |
---|
cmpIs, Copyright, getDataTypeAsString, getReferent, getReferents, getTemplateString, isConstant, logicalAND, logicalNOT, logicalOR |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected byte myValue
Constructor Detail |
public AbleByteLiteral(int theValue)
theValue
- The value to which this literal is to be set.
public AbleByteLiteral(byte theValue)
theValue
- The value to which this literal is to be set.
Method Detail |
public boolean getBooleanValue() throws AbleDataException
getBooleanValue
in class AbleLiteral
AbleDataException
- If the value of this object cannot be represented as
a boolean value.public AbleFuzzySet getFuzzyValue() throws AbleDataException
getFuzzyValue
in class AbleLiteral
AbleDataException
- If the value of this object cannot be represented as
a fuzzy value.public java.lang.Object getGenericValue() throws AbleDataException
getGenericValue
in class AbleLiteral
AbleDataException
- If the value of this object cannot be represented as
an Object.public double getNumericValue() throws AbleDataException
getNumericValue
in class AbleLiteral
AbleDataException
- If the value of this object cannot be represented as
a numeric value.public java.lang.String getStringValue() throws AbleDataException
getStringValue
in class AbleLiteral
AbleDataException
- If the value of this object cannot be represented as
a string value.public AbleLiteral getValue() throws AbleDataException
getValue
in class AbleLiteral
AbleDataException
- If the value of this object cannot be represented as
a literal.public java.lang.Class getDataTypeClass()
AbleLiteral
getDataTypeClass
in class AbleLiteral
com.ibm.able.data.AbleLiteral
public java.lang.String getDataTypeClassName()
AbleLiteral
getDataTypeClassName
in class AbleLiteral
com.ibm.able.data.AbleLiteral
public java.lang.String arlCRdString()
arlCRdString
in class AbleLiteral
public java.lang.String xmlCRdString()
xmlCRdString
in class AbleLiteral
public boolean cmpEq(AbleRd theRhs) throws AbleDataException
"==" is used for numeric and boolean compares; equals() is used for Object compares; and Collator.equals() is used for String compares.
cmpEq
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public boolean cmpGt(AbleRd theRhs) throws AbleDataException
">" is used for numeric compares; Collator.compare() is used for String compares. Use of other data types on the left-hand side causes an exception.
cmpGt
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public boolean cmpGtEq(AbleRd theRhs) throws AbleDataException
">=" is used for numeric compares; Collator.compare() is used for String compares. Use of other data types on the left-hand side causes an exception.
cmpGtEq
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public boolean cmpLt(AbleRd theRhs) throws AbleDataException
"<" is used for numeric compares; Collator.compare() is used for String compares. Use of other data types on the left-hand side causes an exception.
cmpLt
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public boolean cmpLtEq(AbleRd theRhs) throws AbleDataException
"<=" is used for numeric compares; Collator.compare() is used for String compares. Use of other data types on the left-hand side causes an exception.
cmpLtEq
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public boolean cmpNeq(AbleRd theRhs) throws AbleDataException
"!=" is used for numeric and boolean compares; ! equals() is used for Object compares; and ! Collator.equals() is used for String compares.
cmpNeq
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compPlus(AbleRd theRhs) throws AbleDataException
"+" is used for numeric addtion and String concatenation.
compPlus
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compMinus(AbleRd theRhs) throws AbleDataException
"-" is used for numeric subtraction.
compMinus
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compMultiply(AbleRd theRhs) throws AbleDataException
"*" is used for numeric multiplication.
compMultiply
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compDivide(AbleRd theRhs) throws AbleDataException
"/" is used for numeric division.
compDivide
in class AbleLiteral
theRhs
- The right-hand side of the comparison.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral compUnaryMinus(AbleRd theRhs) throws AbleDataException
"-" is used for numeric negation.
compUnaryMinus
in class AbleLiteral
theRhs
- The right-hand side of the operation (ignored).
AbleDataException
- If the value of this data object cannot be negated.public AbleLiteral compModulo(AbleRd theRhs) throws AbleDataException
"%" is used for integer division without remainder.
compModulo
in class AbleLiteral
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseAND(AbleRd theRhs) throws AbleDataException
"&" is used for bitwise AND.
bitwiseAND
in class AbleLiteral
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseOR(AbleRd theRhs) throws AbleDataException
"|" is used for bitwise OR.
bitwiseOR
in class AbleLiteral
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseXOR(AbleRd theRhs) throws AbleDataException
"^" is used for bitwise XOR.
bitwiseXOR
in class AbleLiteral
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseNOT(AbleRd theRhs) throws AbleDataException
"~" is used for bitwise NOT or complement.
bitwiseNOT
in class AbleLiteral
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseShiftLeft(AbleRd theRhs) throws AbleDataException
"&&" is used for boolean AND.
bitwiseShiftLeft
in class AbleLiteral
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseShiftRight(AbleRd theRhs) throws AbleDataException
">>" is used for bitwise shift right.
bitwiseShiftRight
in class AbleLiteral
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public AbleLiteral bitwiseShiftRightZeroFill(AbleRd theRhs) throws AbleDataException
">>" is used for bitwise shift right with zero fill.
bitwiseShiftRightZeroFill
in class AbleLiteral
theRhs
- The right-hand side of the operation.
AbleDataException
- If the right-hand side cannot be converted (if
necessary) and compared to this data object.public boolean equals(java.lang.Object theOtherObject)
equals
in class java.lang.Object
public java.lang.String toString()
AbleLiteral
toString
in class AbleLiteral
com.ibm.able.data.AbleLiteral
public java.lang.String traceString(int theTraceStringFlavor)
traceString
in class AbleLiteral
theFlavor
- An Able.TraceStringFlavor value.
public int getDataType()
AbleLiteral
getDataType
in class AbleLiteral
AbleRd.getDataType()
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |