CByte (josef 3.2.5 API)

java.lang.Object
- java.lang.Number
- - org.josef.science.math.CByte

All Implemented Interfaces:

Serializable, Comparable<CByte>
```
@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
 @ThreadSafety(level=IMMUTABLE)
public final class CByte
extends Number
implements Comparable<CByte>
```
This class wraps a primitive byte value.
The main difference between this class and class Byte is that this class has support for arithmetic operations that protect against both underflow and overflow.
Design considerations: Class Byte is final so this class extends class Number instead. This class is immutable and contains private constructors in combination with static factory methods as suggested by Joshua Bloch (Effective Java, Second Edition, item 15).

Version:

2.0 $Revision: 6488 $

Author:

Kees Schotanus

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BITS_5_TO_8_MASK` Masks the four rightmost bits.
`static int`	`BITS_FOR_ONE_HEX_CHARACTER` Number of bits that represent a single hexadecimal character.
`static int`	`BITS_IN_BYTE` Number of bits in a single byte.
`static int`	`GIGA_BYTE` Number of bytes in a gigabyte.
`static int`	`KILO_BYTE` Number of bytes in a kilobyte.
`static int`	`MEGA_BYTE` Number of bytes in a megabyte.
`static int`	`TERA_BYTE` Number of bytes in a terabyte.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CByte`	`add(byte value)` Adds the supplied value to this value.
`static byte`	`add(byte x, byte y)` Adds y to x.
`byte`	`byteValue()` Returns the value of this CByte as a byte.
`int`	`compareTo(CByte object)` Compares two CByte objects numerically.
`CByte`	`divide(byte value)` Divides this value by the supplied value.
`static byte`	`divide(byte x, byte y)` Divides x by y.
`CByte`	`divideAndFloor(byte value)` Divides this value by the supplied value and floors the result.
`static byte`	`divideAndFloor(byte x, byte y)` Divides x by y and floors the result.
`double`	`doubleValue()` Returns the value of this CByte as a double.
`boolean`	`equals(Object object)` Determines whether this object and the supplied object are the same.
`float`	`floatValue()` Returns the value of this CByte as a float.
`int`	`hashCode()` Computes the hash code value for this object.
`int`	`intValue()` Returns the value of this CByte as an int.
`long`	`longValue()` Returns the value of this CByte as a long.
`CByte`	`multiply(byte value)` Multiplies this value by the supplied value.
`static byte`	`multiply(byte x, byte y)` Multiplies x by y.
`short`	`shortValue()` Returns the value of this CByte as a short.
`CByte`	`subtract(byte value)` Subtracts the supplied value from this value.
`static byte`	`subtract(byte x, byte y)` Subtracts y from x.
`static String`	`toHexadecimalCharacters(byte value)` Converts the supplied value to two hexadecimal characters.
`static String`	`toHexadecimalCharacters(byte[] values)` Converts the supplied byte array value to hexadecimal characters.
`String`	`toString()` Converts the stored primitive byte value to a String.
`static CByte`	`valueOf(byte value)` Returns a CByte object holding the value of the supplied value.
`static CByte`	`valueOf(long value)` Returns a CByte object holding the value of the supplied value.
`static CByte`	`valueOf(Number value)` Returns a CByte object holding the value of the supplied value.
`static CByte`	`valueOf(String value)` Returns a CByte object holding the parsed value of the supplied value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - BITS_IN_BYTE
```
public static final int BITS_IN_BYTE
```
    Number of bits in a single byte.
    
    See Also:
    
    Constant Field Values
  - KILO_BYTE
```
public static final int KILO_BYTE
```
    Number of bytes in a kilobyte.
    
    See Also:
    
    Constant Field Values
  - MEGA_BYTE
```
public static final int MEGA_BYTE
```
    Number of bytes in a megabyte.
    
    See Also:
    
    Constant Field Values
  - GIGA_BYTE
```
public static final int GIGA_BYTE
```
    Number of bytes in a gigabyte.
    
    See Also:
    
    Constant Field Values
  - TERA_BYTE
```
public static final int TERA_BYTE
```
    Number of bytes in a terabyte.
    
    See Also:
    
    Constant Field Values
  - BITS_FOR_ONE_HEX_CHARACTER
```
public static final int BITS_FOR_ONE_HEX_CHARACTER
```
    Number of bits that represent a single hexadecimal character.
    
    See Also:
    
    Constant Field Values
  - BITS_5_TO_8_MASK
```
public static final int BITS_5_TO_8_MASK
```
    Masks the four rightmost bits.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - byteValue
```
public byte byteValue()
```
    Returns the value of this CByte as a byte.
    
    Overrides:
    
    byteValue in class Number
    
    Returns:
    
    The value of this CByte as a byte.
  - shortValue
```
public short shortValue()
```
    Returns the value of this CByte as a short.
    
    Overrides:
    
    shortValue in class Number
    
    Returns:
    
    The value of this CByte as a short.
  - intValue
```
public int intValue()
```
    Returns the value of this CByte as an int.
    
    Specified by:
    
    intValue in class Number
    
    Returns:
    
    The value of this CByte as an int.
  - longValue
```
public long longValue()
```
    Returns the value of this CByte as a long.
    
    Specified by:
    
    longValue in class Number
    
    Returns:
    
    The value of this CByte as a long.
  - floatValue
```
public float floatValue()
```
    Returns the value of this CByte as a float.
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
    
    The value of this CByte as a float.
  - doubleValue
```
public double doubleValue()
```
    Returns the value of this CByte as a double.
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
    
    The value of this CByte as a double.
  - valueOf
```
public static CByte valueOf(byte value)
```
    Returns a CByte object holding the value of the supplied value.
    
    Parameters:
    
    value - The byte value.
    
    Returns:
    
    A CByte object holding the value of the supplied value.
  - valueOf
```
public static CByte valueOf(long value)
```
    Returns a CByte object holding the value of the supplied value.
    
    Parameters:
    
    value - The long value.
    
    Returns:
    
    A CByte object holding the value of the supplied value.
    
    Throws:
    
    IllegalArgumentException - When the supplied value is not in the range: [Byte.MIN_VALUE to Byte.MAX_VALUE].
  - valueOf
```
public static CByte valueOf(Number value)
```
    Returns a CByte object holding the value of the supplied value.
    Depending on the type of the supplied value this may involve rounding.
    
    Parameters:
    
    value - The Number that holds the value.
    
    Returns:
    
    A CByte object holding the value of the supplied value.
    When the supplied value is Not A Number, 0 is returned.
    
    Throws:
    
    NullPointerException - When the supplied value is null.
    
    IllegalArgumentException - When the supplied value is not in the range: [Byte.MIN_VALUE to Byte.MAX_VALUE].
  - valueOf
```
public static CByte valueOf(String value)
```
    Returns a CByte object holding the parsed value of the supplied value.
    
    Parameters:
    
    value - The String that is parsed.
    
    Returns:
    
    A CByte object holding the value of the supplied value, after parsing.
    
    Throws:
    
    IllegalArgumentException - When the supplied value (after parsing) is not in the range: [Byte.MIN_VALUE to Byte.MAX_VALUE].
    
    NumberFormatException - When the supplied value does not contain a parsable byte (this includes a null or empty value).
    
    See Also:
    
    Byte.parseByte(String)
  - equals
```
public boolean equals(Object object)
```
    Determines whether this object and the supplied object are the same.
    The two objects are the same if the supplied object is not null and the supplied object is a CByte and the stored value in both objects is the same.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - The CByte object to compare with.
    
    Returns:
    
    True if both objects are the same, false otherwise.
  - hashCode
```
public int hashCode()
```
    Computes the hash code value for this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    Primitive integer value of the stored byte value.
  - compareTo
```
public int compareTo(CByte object)
```
    Compares two CByte objects numerically.
    
    Specified by:
    
    compareTo in interface Comparable<CByte>
    
    Parameters:
    
    object - CByte object to compare with this object.
    
    Returns:
    
    a negative number when this value < other value, 0 when both values are equal and a positive number when this value > other value.
    
    Throws:
    
    NullPointerException - When the supplied object is null.
    
    See Also:
    
    Comparable
  - add
```
public CByte add(byte value)
```
    Adds the supplied value to this value.
    This method allows for expressions like: CByte value = i.add(x).multiply(y) where i is a CByte and x and y are primitive bytes.
    
    Parameters:
    
    value - Value to add to the stored value.
    
    Returns:
    
    Result of the addition in a new CByte.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs.
    
    See Also:
    
    add(byte, byte)
  - add
```
public static byte add(byte x,
                       byte y)
```
    Adds y to x.
    
    Parameters:
    
    x - Operand one.
    
    y - Operand two.
    
    Returns:
    
    Result of the addition.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs.
  - subtract
```
public CByte subtract(byte value)
```
    Subtracts the supplied value from this value.
    This method allows for expressions like: CByte value = i.subtract(x).multiply(y) where i is a CByte and x and y are primitive bytes.
    
    Parameters:
    
    value - Value to subtract from the stored value.
    
    Returns:
    
    Result of the subtraction in anew CByte.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs.
    
    See Also:
    
    subtract(byte, byte)
  - subtract
```
public static byte subtract(byte x,
                            byte y)
```
    Subtracts y from x.
    
    Parameters:
    
    x - Operand one.
    
    y - operand two.
    
    Returns:
    
    Result of the subtraction.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs.
  - multiply
```
public CByte multiply(byte value)
```
    Multiplies this value by the supplied value.
    This method allows for expressions like: CByte value = i.multiply(x).subtract(y) where i is a CByte and x and y are primitive bytes.
    
    Parameters:
    
    value - Value to multiply by the stored value.
    
    Returns:
    
    Result of the multiplication in a new CByte.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs.
    
    See Also:
    
    multiply(byte, byte)
  - multiply
```
public static byte multiply(byte x,
                            byte y)
```
    Multiplies x by y.
    
    Parameters:
    
    x - Operand one.
    
    y - Operand two.
    
    Returns:
    
    Result of the multiplication.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs.
  - divide
```
public CByte divide(byte value)
```
    Divides this value by the supplied value.
    This method allows for expressions like: CByte value = i.divide(x).add(y) where i is a CByte and x and y are primitive bytes.
    
    Parameters:
    
    value - Value by which this value will be divided.
    
    Returns:
    
    Result of the division in a new CByte.
    
    Throws:
    
    ArithmeticException - When an arithmetic overflow occurs or when the supplied value is 0.
    
    See Also:
    
    divide(byte, byte)
  - divide
```
public static byte divide(byte x,
                          byte y)
```
    Divides x by y.
    
    Parameters:
    
    x - Operand one.
    
    y - Operand two.
    
    Returns:
    
    Result of the division.
    
    Throws:
    
    ArithmeticException - When an arithmetic overflow occurs or when the supplied y value is 0.
  - divideAndFloor
```
public CByte divideAndFloor(byte value)
```
    Divides this value by the supplied value and floors the result.
    This method does not work like integer division in Java. In Java -1 / 4 results in 0 but this method returns a value of -1. It works as if the result of the standard Java division is floored and then returned.
    
    Parameters:
    
    value - Value by which this value will be divided.
    
    Returns:
    
    Result of the division in a new CByte.
    
    Throws:
    
    ArithmeticException - When an arithmetic overflow occurs or when the supplied value is 0.
    
    See Also:
    
    divideAndFloor(byte, byte)
  - divideAndFloor
```
public static byte divideAndFloor(byte x,
                                  byte y)
```
    Divides x by y and floors the result.
    This method does not work like integer division in Java. In Java -1 / 4 results in 0 but this method returns a value of -1. It works as if the result of the standard Java division is floored and then returned.
    
    Parameters:
    
    x - Operand one.
    
    y - Operand two.
    
    Returns:
    
    Result of the division.
    
    Throws:
    
    ArithmeticException - When an arithmetic overflow occurs or when the supplied y value is 0.
  - toHexadecimalCharacters
```
public static String toHexadecimalCharacters(byte value)
```
    Converts the supplied value to two hexadecimal characters.
    A value of 10 for example would be converted to: 0a
    
    Parameters:
    
    value - The value to convert to two hexadecimal characters.
    
    Returns:
    
    Two hexadecimal characters, representing the supplied value.
    The returned String is in lower case.
  - toHexadecimalCharacters
```
public static String toHexadecimalCharacters(byte[] values)
```
    Converts the supplied byte array value to hexadecimal characters.
    Every byte in the supplied array is converted to two hexadecimal characters.
    
    Parameters:
    
    values - The byte array value to convert to hexadecimal characters.
    
    Returns:
    
    The hexadecimal presentation of the supplied byte array value.
    The returned String is in lower case.
  - toString
```
public String toString()
```
    Converts the stored primitive byte value to a String.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of the stored byte value.

Class CByte

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BITS_IN_BYTE

KILO_BYTE

MEGA_BYTE

GIGA_BYTE

TERA_BYTE

BITS_FOR_ONE_HEX_CHARACTER

BITS_5_TO_8_MASK

Method Detail

byteValue

shortValue

intValue

longValue

floatValue

doubleValue

valueOf

valueOf

valueOf

valueOf

equals

hashCode

compareTo

add

add

subtract

subtract

multiply

multiply

divide

divide

divideAndFloor

divideAndFloor

toHexadecimalCharacters

toHexadecimalCharacters

toString