org.jboss.util
Class MuByte

java.lang.Object
  java.lang.Number
      org.jboss.util.MuNumber (src) 
          org.jboss.util.MuByte

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, Mutable (src) , java.io.Serializable

public class MuByte

extends MuNumber (src)

A mutable byte class.

See Also:

Serialized Form

MuByte

public MuByte()

Construct a new mutable byte.

MuByte

public MuByte(byte b)

Construct a new mutable byte.

Parameters:

b - Byte value.

MuByte

public MuByte(java.lang.Object obj)

Construct a new mutable byte.

Parameters:

obj - Object to convert to a byte value.

set

public byte set(byte b)

Set the value.

Parameters:

b - Byte value.

Returns:

The previous value.

get

public byte get()

Get the value.

Returns:

Byte value.

commit

public boolean commit(byte assumed,
                      byte b)

Set the value to value only if the current value is equal to the assumed value.

Parameters:

assumed - The assumed value.

b - The new value.

Returns:

True if value was changed.

swap

public byte swap(MuByte (src)  b)

Swap values with another mutable byte.

Parameters:

b - Mutable byte to swap values with.

Returns:

The new value.

increment

public byte increment()

Increment the value of this mutable byte.

Returns:

Byte value.

decrement

public byte decrement()

Decrement the value of this mutable byte.

Returns:

Byte value.

add

public byte add(byte amount)

Add the specified amount.

Parameters:

amount - Amount to add.

Returns:

The new value.

subtract

public byte subtract(byte amount)

Subtract the specified amount.

Parameters:

amount - Amount to subtract.

Returns:

The new value.

multiply

public byte multiply(byte factor)

Multiply by the specified factor.

Parameters:

factor - Factor to multiply by.

Returns:

The new value.

divide

public byte divide(byte factor)

Divide by the specified factor.

Parameters:

factor - Factor to divide by.

Returns:

The new value.

negate

public byte negate()

Set the value to the negative of its current value.

Returns:

The new value.

complement

public byte complement()

Set the value to its complement.

Returns:

The new value.

and

public byte and(byte b)

ANDs the current value with the specified value.

Parameters:

b - Value to and with.

Returns:

The new value.

or

public byte or(byte b)

ORs the current value with the specified value.

Parameters:

b - Value to or with.

Returns:

The new value.

xor

public byte xor(byte b)

XORs the current value with the specified value.

Parameters:

b - Value to xor with.

Returns:

The new value.

shiftRight

public byte shiftRight(int bits)

Shift the current value to the right.

Parameters:

bits - The number of bits to shift.

Returns:

The new value.

shiftRightZero

public byte shiftRightZero(int bits)

Shift the current value to the right with a zero extension.

Parameters:

bits - The number of bits to shift.

Returns:

The new value.

shiftLeft

public byte shiftLeft(int bits)

Shift the current value to the left.

Parameters:

bits - The number of bits to shift.

Returns:

The new value.

compareTo

public int compareTo(byte other)

Compares this object with the specified byte for order.

Parameters:

other - Value to compare with.

Returns:

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

compareTo

public int compareTo(java.lang.Object obj)
              throws java.lang.ClassCastException

Compares this object with the specified object for order.

Returns:

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

Throws:

java.lang.ClassCastException - Object is not a MuByte.

toString

public java.lang.String toString()

Convert this mutable byte to a string.

Returns:

String value.

hashCode

public int hashCode()

Get the hash code for this mutable byte.

Returns:

Hash code.

equals

public boolean equals(java.lang.Object obj)

Test the equality of this mutable byte and another object.

Parameters:

obj - Object to test equality with.

Returns:

True if object is equal.

clone

public java.lang.Object clone()

Return a cloned copy of this mutable byte.

Returns:

Cloned mutable byte.

byteValue

public byte byteValue()

Return the byte value of this object.

Overrides:

byteValue in class MuNumber (src)

Returns:

byte value.

shortValue

public short shortValue()

Return the short value of this object.

Overrides:

shortValue in class MuNumber (src)

Returns:

short value.

intValue

public int intValue()

Return the int value of this object.

Overrides:

intValue in class MuNumber (src)

Returns:

int value.

longValue

public long longValue()

Return the long value of this object.

Returns:

long value.

floatValue

public float floatValue()

Return the float value of this object.

Overrides:

floatValue in class MuNumber (src)

Returns:

float value.

doubleValue

public double doubleValue()

Return the double value of this object.

Returns:

double value.

setValue

public void setValue(java.lang.Object obj)

Set the value of this mutable byte.

Parameters:

obj - Object to convert to a byte value.

getValue

public java.lang.Object getValue()

Get the byte value of this mutable byte.

Returns:

java.lang.Byte value.