fr.gael.drb.value
Class UnsignedShort

java.lang.Object
  fr.gael.drb.value.UnsignedShort

All Implemented Interfaces:

DrbItem, Arithmetic, Comparison, Logic, Numeric, Sumable, Value, ValueFormat, Serializable, Comparable

public class UnsignedShort
extends Object
implements ValueFormat

The UnsignedShort class is a generic wrapper for unsigned short values.

See Also:

Serialized Form

Field Summary

Fields inherited from interface fr.gael.drb.value.Value

ARRAY_ID, BINARY_ID, BINARY_INTEGER_ID, BOOLEAN_ID, BYTE_ID, DATE_ID, DATE_TIME_ID, DAY_ID, DAY_TIME_DURATION_ID, DECIMAL_ID, DOUBLE_ID, DURATION_ID, FLOAT_ID, INT_ID, INTEGER_ID, LONG_ID, MONTH_DAY_ID, MONTH_ID, NULL_ID, NUMERIC_ID, OTHER_ID, SHORT_ID, STRING_ID, TIME_ID, UNKNOWN_ID, UNSIGNED_BYTE_ID, UNSIGNED_INT_ID, UNSIGNED_LONG_ID, UNSIGNED_SHORT_ID, YEAR_ID, YEAR_MONTH_DURATION_ID, YEAR_MONTH_ID

Fields inherited from interface fr.gael.drb.DrbItem

ATTRIBUTE_ITEM, NODE_ITEM, UNDEFINED_ITEM, VALUE_ITEM

Constructor Summary

UnsignedShort(int value)
Builds an UnsignedShort object initialized to the specified int value.

UnsignedShort(short value)
Builds an UnsignedShort object initialized to the specified short value.

Method Summary

Value	add(Value x) Adds the specified value to the current short value.
boolean	and(Value x) Compute a logical AND.
void	assign(boolean value) assign a new boolean value
void	assign(byte value) assign a new byte value
void	assign(double value) assign a new double value
void	assign(float value) assign a new float value
void	assign(int value) assign a new int value
void	assign(long value) assign a new long value
void	assign(short value) assign a new short value
void	assign(Value v) assign a new Value
boolean	booleanValue() indicates if the value is not 0
byte	byteValue() return the byte value.
int	compareTo(Object obj) Compares this object with the specified object for order.
int	compareTo(Value x) compare the current value to the given one.
Value	convertTo(int type) In particular this operation that performs non obvious conversions.
protected BigDecimal	decimalValue() Returns this value as a BigDecimal.
Value	divide(Value x) Divides the specified value by the current short value.
double	doubleValue() return the double value.
boolean	equals(Object obj) Indicates whether this value is "equal to" to another value.
float	floatValue() return the float value.
byte[]	getFormattedBuffer() Returns a byte buffer containing the value in a fixed format.
String	getFormattedString(int length) Returns a string containing the value with a fixed format.
int	getItemType() A code that identifies the value items.
String	getName() Name of the item.
String	getNamespaceURI() Get namespace URI.
int	getPriority() Returns the current Value priority.
int	getType() Returns the current Value type
Value	getValue() The value of the item.
int	hashCode() Returns a hash code value for the object.
protected BigInteger	integerValue() Returns this value as a BigInteger.
int	intValue() return the int value.
long	longValue() return the long value.
Value	modulus(Value x) Compute the modulus of the current short value by the specified value.
Value	multiply(Value x) Multiply the specified value by the current short value.
boolean	or(Value x) Compute a logical OR.
void	rename(String name) Changes the name of the item.
void	setNamespaceURI(String namespace_uri) Sets a namespace resource identifier.
Value	setValue(Value value) Changes the value of the item.
short	shortValue() return the short value.
Value	sub(Value x) Substracts the specified value to the current short value.
Numeric	toNumeric() Convert the value into the numeric type.
String	toString() Prints the value of the Short in a character string.
Value	unaryMinus() Returns a Value containing the opposite of the current Value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface fr.gael.drb.DrbItem

getItemType, getName, getNamespaceURI, getValue, rename, setNamespaceURI, setValue

Constructor Detail

UnsignedShort

public UnsignedShort(short value)

Builds an UnsignedShort object initialized to the specified short value.

Parameters:

value - the value of the UnsignedShort.

UnsignedShort

public UnsignedShort(int value)

Builds an UnsignedShort object initialized to the specified int value. A cast is perform to fit the specified integer to the short representation. The cast mechanism is the one of Java.

Parameters:

value - the value of the Short.

Method Detail

toString

public String toString()

Prints the value of the Short in a character string.

Overrides:

toString in class Object

Returns:

a string representation of the short. The returned value cannot be null.

getFormattedString

public String getFormattedString(int length)

Returns a string containing the value with a fixed format.

Specified by:

getFormattedString in interface ValueFormat

Parameters:

length - The expected length of the output string

Returns:

The formatted string.

getFormattedBuffer

public byte[] getFormattedBuffer()

Returns a byte buffer containing the value in a fixed format.

Specified by:

getFormattedBuffer in interface ValueFormat

Returns:

The formatted buffer.

getType

public final int getType()

Returns the current Value type

Specified by:

getType in interface Value

Returns:

the current Value type

getPriority

public final int getPriority()

Returns the current Value priority.

Specified by:

getPriority in interface Value

Returns:

the current Value priority

convertTo

public final Value convertTo(int type)
                      throws ClassCastException

In particular this operation that performs non obvious conversions. The comment is an important spec for the DRB user.

Specified by:

convertTo in interface Value

Parameters:

type - the type in which convert

Returns:

the converted Value

Throws:

ClassCastException - if the conversion is impossible

assign

public void assign(Value v)

assign a new Value

Specified by:

assign in interface Value

Parameters:

v - the new Value

unaryMinus

public Value unaryMinus()

Returns a Value containing the opposite of the current Value.

Specified by:

unaryMinus in interface Arithmetic

Returns:

a Value containing the opposite of the current Value.

add

public final Value add(Value x)

Adds the specified value to the current short value.

Specified by:

add in interface Sumable

Parameters:

x - another value.

Returns:

the sum of the two values.

sub

public Value sub(Value x)

Substracts the specified value to the current short value.

Specified by:

sub in interface Arithmetic

Parameters:

x - another value.

Returns:

the difference between the two values.

multiply

public Value multiply(Value x)

Multiply the specified value by the current short value.

Specified by:

multiply in interface Arithmetic

Parameters:

x - another value.

Returns:

the product of the two values.

divide

public final Value divide(Value x)

Divides the specified value by the current short value.

Specified by:

divide in interface Arithmetic

Parameters:

x - another value.

Returns:

the ratio of the two values.

modulus

public Value modulus(Value x)

Compute the modulus of the current short value by the specified value.

Specified by:

modulus in interface Arithmetic

Parameters:

x - another value.

Returns:

the modulus of the values.

compareTo

public int compareTo(Value x)

compare the current value to the given one.

Specified by:

compareTo in interface Comparison

Parameters:

x - the Value to compare

Returns:

a negative number if the current value is greater, a positive number if the given value is greater, 0 if there are equal

booleanValue

public final boolean booleanValue()

indicates if the value is not 0

Specified by:

booleanValue in interface Logic

Returns:

true if the value is not 0

byteValue

public final byte byteValue()

return the byte value.

Specified by:

byteValue in interface Numeric

Returns:

the byte value

intValue

public final int intValue()

return the int value.

Specified by:

intValue in interface Numeric

Returns:

the int value

longValue

public final long longValue()

return the long value.

Specified by:

longValue in interface Numeric

Returns:

the long value

shortValue

public final short shortValue()

return the short value.

Specified by:

shortValue in interface Numeric

Returns:

the short value

floatValue

public final float floatValue()

return the float value.

Specified by:

floatValue in interface Numeric

Returns:

the float value

doubleValue

public final double doubleValue()

return the double value.

Specified by:

doubleValue in interface Numeric

Returns:

the double value

assign

public final void assign(boolean value)

assign a new boolean value

Specified by:

assign in interface Numeric

Parameters:

value - the new value to assign

assign

public final void assign(byte value)

assign a new byte value

Specified by:

assign in interface Numeric

Parameters:

value - the new value to assign

assign

public final void assign(int value)

assign a new int value

Specified by:

assign in interface Numeric

Parameters:

value - the new value to assign

assign

public final void assign(short value)

assign a new short value

Specified by:

assign in interface Numeric

Parameters:

value - the new value to assign

assign

public final void assign(long value)

assign a new long value

Specified by:

assign in interface Numeric

Parameters:

value - the new value to assign

assign

public final void assign(float value)

assign a new float value

Specified by:

assign in interface Numeric

Parameters:

value - the new value to assign

assign

public final void assign(double value)

assign a new double value

Specified by:

assign in interface Numeric

Parameters:

value - the new value to assign

equals

public boolean equals(Object obj)

Indicates whether this value is "equal to" to another value. See Object.equals() for the general contract of this method.

Overrides:

equals in class Object

Parameters:

obj - another value.

Returns:

true if this object is the same as the obj argument

hashCode

public int hashCode()

Returns a hash code value for the object. See Object.hashCode() for the general contract of this method.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

compareTo

public int compareTo(Object obj)

Compares this object with the specified object for order. See Comparable.compareTo() for the general contract of this method.

Specified by:

compareTo in interface Comparable

Parameters:

obj - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

toNumeric

public final Numeric toNumeric()
                        throws ClassCastException

Convert the value into the numeric type. In case of identity conversion the value itself should be returned. If the conversion is not allowed a ClassCastException is thrown.

Returns:

The converted value.

Throws:

ClassCastException - is the convertion is impossible

integerValue

protected BigInteger integerValue()

Returns this value as a BigInteger. The conversion may result in a loss of precision.

Returns:

the numeric value represented by this object after conversion to type BigInteger.

decimalValue

protected BigDecimal decimalValue()

Returns this value as a BigDecimal. The conversion may result in a loss of precision.

Returns:

the numeric value represented by this object after conversion to type BigDecimal.

and

public final boolean and(Value x)

Compute a logical AND.

Specified by:

and in interface Logic

Parameters:

x - another value.

Returns:

logical AND of the two values.

or

public final boolean or(Value x)

Compute a logical OR.

Specified by:

or in interface Logic

Parameters:

x - another value.

Returns:

logical OR of the two values.

getItemType

public int getItemType()

A code that identifies the value items.

Specified by:

getItemType in interface DrbItem

Returns:

The code of value items.

getName

public String getName()

Name of the item. This method always returns null.

Specified by:

getName in interface DrbItem

Returns:

null

rename

public void rename(String name)
            throws NullPointerException,
                   UnsupportedOperationException

Changes the name of the item. This method always throw an UnsupportedOperationException.

Specified by:

rename in interface DrbItem

Parameters:

name - Reference to the new name.

Throws:

UnsupportedOperationException - This exception always raised because the name property is not defined for values.

NullPointerException - This exception is overriden by an UnsupportedOperationException.

getNamespaceURI

public String getNamespaceURI()

Get namespace URI. This method always returns null.

Specified by:

getNamespaceURI in interface DrbItem

Returns:

null.

setNamespaceURI

public void setNamespaceURI(String namespace_uri)
                     throws NullPointerException,
                            UnsupportedOperationException

Sets a namespace resource identifier. This method always throw an UnsupportedOperationException.

Specified by:

setNamespaceURI in interface DrbItem

Parameters:

namespace_uri - A reference to the new namespace identifier.

Throws:

UnsupportedOperationException - This exception always raised because the name property is not defined for values.

NullPointerException - This exception is overriden by an UnsupportedOperationException.

getValue

public Value getValue()

The value of the item. The value is expressed according to one of the types supported by the fr.gael.drb.value package. Generally these types correspond to primitive types (e.g. integer, floatting points, etc.) or very low level types (e.g. string, date, etc.). On the contrary to DOM implementation all the types are allowed even the arrays, date etc. Only the Value.NULL_ID type is forbidden.

Specified by:

getValue in interface DrbItem

Returns:

The value of the attribute.

setValue

public Value setValue(Value value)
               throws NullPointerException,
                      ClassCastException,
                      UnsupportedOperationException

Changes the value of the item. This operation sets a new value of the current item.The value type of the item shall be compatible with the item implementation. If the type does not match exactly it is casted to a compatible one based on the the fr.gael.drb.value capabilities. A reference to the effectivelly assigned value is returned by the operation so it is possible to check if a cast has been performed and therefore assess the accuracy of the assignement. If the cast is not possible the operation raises an UnsupportedOperationException. If the assignment is possible and the item implementation has a physical representation the value is updated in the physical source in order to persist among sessions. It therefore possible that this operation consumses an variable time.

Specified by:

setValue in interface DrbItem

Parameters:

value - The new value of the node. This value shall not be null.

Returns:

The effectivelly assigned value. The type of this value may differ from the input one.

Throws:

NullPointerException - This exception is raised when the passed reference to the value is null. This exception may be overriden by an UnsupportedOperationException.

ClassCastException - This exception is raised when the implementation has not succeeded to cast the input value in a type compatible with the current node.

UnsupportedOperationException - This exception is raised when the implementation does not support the requested assignment for any reason.