Referenznummer10 (jDTAUS Banking ⁑ API 1.16)

java.lang.Object
- java.lang.Number
- - org.jdtaus.banking.Referenznummer10

All Implemented Interfaces:

Serializable, Comparable
```
public final class Referenznummer10
extends Number
implements Comparable
```
Unique entity identifier.
A Referenznummer10 is a positive integer with a maximum of ten digits.

Version:

$JDTAUS: Referenznummer10.java 8661 2012-09-27 11:29:58Z schulte $

Author:

Christian Schulte

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ELECTRONIC_FORMAT` Constant for the electronic format of a Referenznummer10.
`static int`	`LETTER_FORMAT` Constant for the letter format of a Referenznummer10.
`static int`	`MAX_CHARACTERS` Maximum number of characters of a Referenznummer10.
`static int`	`MAX_DIGITS` Maximum number of digits of a Referenznummer10.

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`checkReferenznummer10(Number referenceCode)` Checks a given number to conform to a Referenznummer10.
`int`	`compareTo(Object o)` Compares this object with the specified object for order.
`double`	`doubleValue()` Returns this Referenznummer10 as a double value.
`boolean`	`equals(Object o)` Indicates whether some other object is equal to this one.
`float`	`floatValue()` Returns this Referenznummer10 as a float value.
`String`	`format(int style)` Formats a Referenznummer10 to produce a string.
`StringBuffer`	`format(int style, StringBuffer toAppendTo)` Formats a Referenznummer10 and appends the resulting text to the given string buffer.
`int`	`hashCode()` Returns a hash code value for this object.
`int`	`intValue()` Returns this Referenznummer10 as an int value.
`long`	`longValue()` Returns this Referenznummer10 as a long value.
`static Referenznummer10`	`parse(String referenceCode)` Parses text from the beginning of the given string to produce a `Referenznummer10`.
`static Referenznummer10`	`parse(String referenceCode, ParsePosition pos)` Parses text from a string to produce a `Referenznummer10`.
`String`	`toString()` Returns a string representation of the object.
`static String`	`toString(Referenznummer10 referenznummer10)` Formats a Referenznummer10 to produce a string.
`static Referenznummer10`	`valueOf(Number referenceCode)` Returns an instance for the Referenznummer10 identified by the given number.
`static Referenznummer10`	`valueOf(String referenceCode)` Parses text from the beginning of the given string to produce a `Referenznummer10`.

Methods inherited from class java.lang.Number
byteValue, shortValue

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

- Field Detail
  - ELECTRONIC_FORMAT
```
public static final int ELECTRONIC_FORMAT
```
    Constant for the electronic format of a Referenznummer10.
    The electronic format of a Referenznummer10 is a ten digit number with leading zeros omitted (e.g. 6789).
    
    See Also:
    Constant Field Values
  - LETTER_FORMAT
```
public static final int LETTER_FORMAT
```
    Constant for the letter format of a Referenznummer10.
    The letter format of a Referenznummer10 is a ten digit number with leading zeros omitted separated by spaces between the first three digits and the second three digits, the second three digits and the third three digits, and between the third three digits and the last digit (e.g. 123 456 789 0).
    
    See Also:
    Constant Field Values
  - MAX_CHARACTERS
```
public static final int MAX_CHARACTERS
```
    Maximum number of characters of a Referenznummer10.
    
    See Also:
    Constant Field Values
  - MAX_DIGITS
```
public static final int MAX_DIGITS
```
    Maximum number of digits of a Referenznummer10.
    
    See Also:
    Constant Field Values
- Method Detail
  - checkReferenznummer10
```
public static boolean checkReferenznummer10(Number referenceCode)
```
    Checks a given number to conform to a Referenznummer10.
    
    Parameters:
    referenceCode - The number to check.
    
    Returns:
    true if referenceCode is a valid Referenznummer10; false if not.
  - compareTo
```
public int compareTo(Object o)
```
    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.
    
    Specified by:
    
    compareTo in interface Comparable
    
    Parameters:
    o - 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.
    
    Throws:
    
    NullPointerException - if o is null.
    
    ClassCastException - if the specified object's type prevents it from being compared to this Object.
  - doubleValue
```
public double doubleValue()
```
    Returns this Referenznummer10 as a double value.
    
    Specified by:
    
    doubleValue in class Number
    
    Returns:
    This Referenznummer10 as a double value.
  - equals
```
public boolean equals(Object o)
```
    Indicates whether some other object is equal to this one.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - The reference object with which to compare.
    
    Returns:
    true if this object is the same as o; false otherwise.
  - floatValue
```
public float floatValue()
```
    Returns this Referenznummer10 as a float value.
    
    Specified by:
    
    floatValue in class Number
    
    Returns:
    This Referenznummer10 as a float value.
  - format
```
public String format(int style)
```
    Formats a Referenznummer10 to produce a string. Same as
    format(style, new StringBuffer()).toString()
    
    Parameters:
    style - The style to use (ELECTRONIC_FORMAT or LETTER_FORMAT).
    
    Returns:
    The formatted string.
    
    Throws:
    
    IllegalArgumentException - if style is neither ELECTRONIC_FORMAT nor LETTER_FORMAT.
    See Also:
    ELECTRONIC_FORMAT, LETTER_FORMAT
  - format
```
public StringBuffer format(int style,
                  StringBuffer toAppendTo)
```
    Formats a Referenznummer10 and appends the resulting text to the given string buffer.
    
    Parameters:
    style - The style to use (ELECTRONIC_FORMAT or LETTER_FORMAT).
    toAppendTo - The buffer to which the formatted text is to be appended.
    
    Returns:
    The value passed in as toAppendTo.
    
    Throws:
    
    NullPointerException - if toAppendTo is null.
    
    IllegalArgumentException - if style is neither ELECTRONIC_FORMAT nor LETTER_FORMAT.
    See Also:
    ELECTRONIC_FORMAT, LETTER_FORMAT
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    A hash code value for this object.
  - intValue
```
public int intValue()
```
    Returns this Referenznummer10 as an int value.
    
    Specified by:
    
    intValue in class Number
    
    Returns:
    This Referenznummer10 as an int value.
  - longValue
```
public long longValue()
```
    Returns this Referenznummer10 as a long value.
    
    Specified by:
    
    longValue in class Number
    
    Returns:
    This Referenznummer10 as a long value.
  - parse
```
public static Referenznummer10 parse(String referenceCode)
                              throws ParseException
```
    Parses text from the beginning of the given string to produce a Referenznummer10.
    Unlike the parse(String, ParsePosition) method this method throws a ParseException if referenceCode cannot be parsed or is of invalid length.
    
    Parameters:
    referenceCode - A Referenznummer10 in either electronic or letter format.
    
    Returns:
    The parsed value.
    
    Throws:
    
    NullPointerException - if referenceCode is null.
    
    ParseException - if the parse fails or referenceCode is of invalid length.
  - parse
```
public static Referenznummer10 parse(String referenceCode,
                     ParsePosition pos)
```
    Parses text from a string to produce a Referenznummer10.
    The method attempts to parse text starting at the index given by pos. If parsing succeeds, then the index of pos is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed value is returned. The updated pos can be used to indicate the starting point for the next call to this method.
    
    Parameters:
    referenceCode - A Referenznummer10 in either electronic or letter format.
    pos - A ParsePosition object with index and error index information as described above.
    
    Returns:
    The parsed value, or null if the parse fails.
    
    Throws:
    
    NullPointerException - if either referenceCode or pos is null.
  - toString
```
public String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of the object.
  - toString
```
public static String toString(Referenznummer10 referenznummer10)
```
    Formats a Referenznummer10 to produce a string. Same as
    referenznummer10.format(ELECTRONIC_FORMAT)
    
    Parameters:
    referenznummer10 - The Referenznummer10 instance to format.
    
    Returns:
    The formatted string.
    
    Throws:
    
    NullPointerException - if referenznummer10 is null.
  - valueOf
```
public static Referenznummer10 valueOf(Number referenceCode)
```
    Returns an instance for the Referenznummer10 identified by the given number.
    
    Parameters:
    referenceCode - A number identifying a Referenznummer10.
    
    Returns:
    An instance for referenceCode.
    
    Throws:
    
    NullPointerException - if referenceCode is null.
    
    IllegalArgumentException - if referenceCode is negative, zero or greater than 9999999999.
    See Also:
    checkReferenznummer10(Number)
  - valueOf
```
public static Referenznummer10 valueOf(String referenceCode)
```
    Parses text from the beginning of the given string to produce a Referenznummer10.
    Unlike the parse(String) method this method throws an IllegalArgumentException if referenceCode cannot be parsed or is of invalid length.
    
    Parameters:
    referenceCode - A Referenznummer10 in either electronic or letter format.
    
    Returns:
    The parsed value.
    
    Throws:
    
    NullPointerException - if referenceCode is null.
    
    IllegalArgumentException - if the parse fails or referenceCode is of invalid length.

Class Referenznummer10

Field Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

ELECTRONIC_FORMAT

LETTER_FORMAT

MAX_CHARACTERS

MAX_DIGITS

Method Detail

checkReferenznummer10

compareTo

doubleValue

equals

floatValue

format

format

hashCode

intValue

longValue

parse

parse

toString

toString

valueOf

valueOf