CShort (josef 3.2.5 API)

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

All Implemented Interfaces:

Serializable, Comparable<CShort>
```
@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
 @ThreadSafety(level=IMMUTABLE)
public final class CShort
extends Number
implements Comparable<CShort>
```
This class wraps a primitive short value.
The main difference between this class and class Short is that this class has support for arithmetic operations that protect against both underflow and overflow.
Design considerations: Class Short 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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CShort`	`add(short value)` Adds the supplied value to this value.
`static short`	`add(short x, short y)` Adds y to x.
`byte`	`byteValue()` Returns the value of this CShort as a byte.
`int`	`compareTo(CShort object)` Compares two CShort objects numerically.
`CShort`	`divide(short value)` Divides this value by the supplied value.
`static short`	`divide(short x, short y)` Divides x by y.
`CShort`	`divideAndFloor(short value)` Divides this value by the supplied value and floors the result.
`static short`	`divideAndFloor(short x, short y)` Divides x by y and floors the result.
`double`	`doubleValue()` Returns the value of this CShort 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 CShort as a float.
`int`	`hashCode()` Computes the hash code value for this object.
`int`	`intValue()` Returns the value of this CShort as an int.
`long`	`longValue()` Returns the value of this CShort as a long.
`CShort`	`multiply(short value)` Multiplies this value by the supplied value.
`static short`	`multiply(short x, short y)` Multiplies x by y.
`short`	`shortValue()` Returns the value of this CShort as a short.
`CShort`	`subtract(short value)` Subtracts the supplied value from this value.
`static short`	`subtract(short x, short y)` Subtracts y from x.
`String`	`toString()` Converts the stored primitive short value to a String.
`static CShort`	`valueOf(long value)` Returns a CShort object holding the value of the supplied value.
`static CShort`	`valueOf(Number value)` Returns a CShort object holding the value of the supplied value.
`static CShort`	`valueOf(short value)` Returns a CShort object holding the value of the supplied value.
`static CShort`	`valueOf(String value)` Returns a CShort object holding the parsed value of the supplied value.

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

- Method Detail
  - byteValue
```
public byte byteValue()
```
    Returns the value of this CShort as a byte.
    
    Overrides:
    
    byteValue in class Number
    
    Returns:
    
    The value of this CShort as a byte.
  - shortValue
```
public short shortValue()
```
    Returns the value of this CShort as a short.
    
    Overrides:
    
    shortValue in class Number
    
    Returns:
    
    The value of this CShort as a short.
  - intValue
```
public int intValue()
```
    Returns the value of this CShort as an int.
    
    Specified by:
    
    intValue in class Number
    
    Returns:
    
    The value of this CShort as an int.
  - longValue
```
public long longValue()
```
    Returns the value of this CShort as a long.
    
    Specified by:
    
    longValue in class Number
    
    Returns:
    
    The value of this CShort as a long.
  - floatValue
```
public float floatValue()
```
    Returns the value of this CShort as a float.
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
    
    The value of this CShort as a float.
  - doubleValue
```
public double doubleValue()
```
    Returns the value of this CShort as a double.
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
    
    The value of this CShort as a double.
  - valueOf
```
public static CShort valueOf(short value)
```
    Returns a CShort object holding the value of the supplied value.
    
    Parameters:
    
    value - The short value.
    
    Returns:
    
    A CShort object holding the value of the supplied value.
  - valueOf
```
public static CShort valueOf(long value)
```
    Returns a CShort object holding the value of the supplied value.
    
    Parameters:
    
    value - The long value.
    
    Returns:
    
    A CShort object holding the value of the supplied value.
    
    Throws:
    
    IllegalArgumentException - When the supplied value is not in the range: [Short.MIN_VALUE to Short.MAX_VALUE].
  - valueOf
```
public static CShort valueOf(Number value)
```
    Returns a CShort 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 CShort 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: [Short.MIN_VALUE to Short.MAX_VALUE].
  - valueOf
```
public static CShort valueOf(String value)
```
    Returns a CShort object holding the parsed value of the supplied value.
    
    Parameters:
    
    value - The String that is parsed.
    
    Returns:
    
    A CShort object holding the value of the supplied value, after parsing.
    
    Throws:
    
    IllegalArgumentException - When the supplied value (after parsing) is not in the range: [Short.MIN_VALUE to Short.MAX_VALUE].
    
    NumberFormatException - When the supplied value does not contain a parsable short (this includes a null or empty value).
    
    See Also:
    
    Short.parseShort(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 CShort and the stored value in both objects is the same.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - The CShort 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 short value.
  - compareTo
```
public int compareTo(CShort object)
```
    Compares two CShort objects numerically.
    
    Specified by:
    
    compareTo in interface Comparable<CShort>
    
    Parameters:
    
    object - CShort 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 CShort add(short value)
```
    Adds the supplied value to this value.
    This method allows for expressions like: CShort value = i.add(x).multiply(y) where i is a CShort and x and y are primitive shorts.
    
    Parameters:
    
    value - Value to add to the stored value.
    
    Returns:
    
    Result of the addition in a new CShort.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs.
    
    See Also:
    
    add(short, short)
  - add
```
public static short add(short x,
                        short 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 CShort subtract(short value)
```
    Subtracts the supplied value from this value.
    This method allows for expressions like: CShort value = i.subtract(x).multiply(y) where i is a CShort and x and y are primitive shorts.
    
    Parameters:
    
    value - Value to subtract from the stored value.
    
    Returns:
    
    Result of the subtraction in a new CShort.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs.
    
    See Also:
    
    subtract(short, short)
  - subtract
```
public static short subtract(short x,
                             short 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 CShort multiply(short value)
```
    Multiplies this value by the supplied value.
    This method allows for expressions like: CShort value = i.multiply(x).subtract(y) where i is a CShort and x and y are primitive shorts.
    
    Parameters:
    
    value - Value to multiply by the stored value.
    
    Returns:
    
    Result of the multiplication in a new CShort.
    
    Throws:
    
    ArithmeticException - When an arithmetic underflow or overflow occurs.
    
    See Also:
    
    multiply(short, short)
  - multiply
```
public static short multiply(short x,
                             short 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 CShort divide(short value)
```
    Divides this value by the supplied value.
    This method allows for expressions like: CShort value = i.divide(x).add(y) where i is a CShort and x and y are primitive shorts.
    
    Parameters:
    
    value - Value by which this value will be divided.
    
    Returns:
    
    Result of the division in a new CShort.
    
    Throws:
    
    ArithmeticException - When an arithmetic overflow occurs or when the supplied value is 0.
    
    See Also:
    
    divide(short, short)
  - divide
```
public static short divide(short x,
                           short 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 CShort divideAndFloor(short 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 CShort.
    
    Throws:
    
    ArithmeticException - When an arithmetic overflow occurs or when the supplied value is 0.
    
    See Also:
    
    divideAndFloor(short, short)
  - divideAndFloor
```
public static short divideAndFloor(short x,
                                   short 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.
  - toString
```
public String toString()
```
    Converts the stored primitive short value to a String.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of the stored short value.

Class CShort

Method Summary

Methods inherited from class java.lang.Object

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

toString