AlphaNumericText27 (jDTAUS Banking ⁑ API 1.16)

java.lang.Object
- org.jdtaus.banking.AlphaNumericText27

All Implemented Interfaces:

Serializable, CharSequence, Comparable
```
public final class AlphaNumericText27
extends Object
implements CharSequence, Comparable, Serializable
```
Alpha numeric text with a maximum length of twenty seven characters.
Data type for the alpha-numeric DTAUS alphabet. For further information see the Spezifikation der Datenformate. An updated version of the document may be found at EBICS.

Version:

$JDTAUS: AlphaNumericText27.java 8860 2014-01-10 17:09:37Z schulte $

Author:

Christian Schulte

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_LENGTH
Constant for the maximum length allowed for an instance.

Fields
Modifier and Type	Field and Description
`static int`	`MAX_LENGTH` Constant for the maximum length allowed for an instance.

Method Summary

Methods
Modifier and Type	Method and Description
`char`	`charAt(int index)` Returns the `char` value at the specified index.
`static boolean`	`checkAlphaNumeric(char c)` Checks a given character to belong to the alpha-numeric alphabet.
`int`	`compareTo(Object o)` Compares this object with the specified object for order.
`boolean`	`equals(Object o)` Indicates whether some other object is equal to this one.
`String`	`format()` Formats alpha-numeric characters to produce a string.
`StringBuffer`	`format(StringBuffer toAppendTo)` Formats alpha-numeric characters and appends the resulting text to the given string buffer.
`int`	`hashCode()` Returns a hash code value for this object.
`boolean`	`isEmpty()` Flag indicating that the instance contains no text.
`int`	`length()` Returns the length of this character sequence.
`static String`	`normalize(String text)` Normalizes text to conform to the alpha-numeric alphabet.
`static AlphaNumericText27`	`parse(String text)` Parses text from the beginning of the given string to produce an `AlphaNumericText27` instance.
`static AlphaNumericText27`	`parse(String text, ParsePosition pos)` Parses text from a string to produce an `AlphaNumericText27` instance.
`CharSequence`	`subSequence(int start, int end)` Returns a new `CharSequence` that is a subsequence of this sequence.
`String`	`toString()` Returns a string containing the characters in this sequence in the same order as this sequence.
`static String`	`toString(AlphaNumericText27 alphaNumericText27)` Formats alpha-numeric characters to produce a string.
`static AlphaNumericText27`	`valueOf(String text)` Parses text from the beginning of the given string to produce an `AlphaNumericText27` instance.

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

- Field Detail
  - MAX_LENGTH
```
public static final int MAX_LENGTH
```
    Constant for the maximum length allowed for an instance.
    
    See Also:
    Constant Field Values
- Method Detail
  - charAt
```
public char charAt(int index)
```
    Returns the char value at the specified index.
    An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.
    
    Specified by:
    
    charAt in interface CharSequence
    
    Parameters:
    index - The index of the char value to be returned.
    
    Returns:
    The specified char value.
    
    Throws:
    
    IndexOutOfBoundsException - if index is negative or not less than length().
  - checkAlphaNumeric
```
public static boolean checkAlphaNumeric(char c)
```
    Checks a given character to belong to the alpha-numeric alphabet.
    
    Parameters:
    c - The character to check.
    
    Returns:
    true if c is a character of the alpha-numeric DTAUS alphabet; 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.
  - 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.
  - format
```
public String format()
```
    Formats alpha-numeric characters to produce a string. Same as
    format(new StringBuffer()).toString()
    
    Returns:
    The formatted string.
  - format
```
public StringBuffer format(StringBuffer toAppendTo)
```
    Formats alpha-numeric characters and appends the resulting text to the given string buffer.
    
    Parameters:
    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.
  - 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.
  - isEmpty
```
public boolean isEmpty()
```
    Flag indicating that the instance contains no text.
    
    Returns:
    true if the instance contains no text but just whitespace characters; false if the instance contains text.
  - length
```
public int length()
```
    Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.
    
    Specified by:
    
    length in interface CharSequence
    
    Returns:
    The number of chars in this sequence.
  - normalize
```
public static String normalize(String text)
```
    Normalizes text to conform to the alpha-numeric alphabet.
    This method converts lower case letters to upper case letters and replaces all illegal characters with spaces. It will return the unchanged text if for every given character C the method checkAlphaNumeric(C) returns true.
    
    Note that code like
    AlphaNumericText27.parse(AlphaNumericText27.normalize(getSomething()));
    may be dangerous if getSomething() may provide unchecked or otherwise invalid data which will get converted to valid data by this method.
    
    Also note that
    AlphaNumericText27.normalize(something).length() == something.length();
    is always true although
    AlphaNumericText27.normalize(something).equals(something);
    may be false.
    
    It is recommended to always check for changes before proceeding with the data this method returns. For example:
    something = getSomething(); normalized = AlphaNumericText27.normalize(something); if(!something.equals(normalized)) { e.g. check the normalized value, log a warning, display the normalized value to the user for confirmation }
    Parameters:
    text - The text to normalize.
    
    Returns:
    text normalized to conform to the alpha-numeric alphabet.
    
    Throws:
    
    NullPointerException - if text is null.
  - parse
```
public static AlphaNumericText27 parse(String text)
                                throws ParseException
```
    Parses text from the beginning of the given string to produce an AlphaNumericText27 instance.
    Unlike the parse(String, ParsePosition) method this method throws a ParseException if text cannot be parsed or is of invalid length.
    
    Parameters:
    text - A string to parse alpha numeric characters from.
    
    Returns:
    The parsed value.
    
    Throws:
    
    NullPointerException - if text is null.
    
    ParseException - if the parse fails or the length of text is greater than 27.
  - parse
```
public static AlphaNumericText27 parse(String text,
                       ParsePosition pos)
```
    Parses text from a string to produce an AlphaNumericText27 instance.
    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:
    text - A string to parse alpha numeric characters from.
    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 text or pos is null.
  - subSequence
```
public CharSequence subSequence(int start,
                       int end)
```
    Returns a new CharSequence that is a subsequence of this sequence.
    The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.
    
    Specified by:
    
    subSequence in interface CharSequence
    
    Parameters:
    start - The start index, inclusive.
    end - The end index, exclusive.
    
    Returns:
    The specified subsequence.
    
    Throws:
    
    IndexOutOfBoundsException - if start or end are negative, if end is greater than length(), or if start is greater than end.
  - toString
```
public String toString()
```
    Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.
    
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string consisting of exactly this sequence of characters.
  - toString
```
public static String toString(AlphaNumericText27 alphaNumericText27)
```
    Formats alpha-numeric characters to produce a string. Same as
    alphaNumericText27.format()
    
    Parameters:
    alphaNumericText27 - The AlphaNumericText27 instance to format.
    
    Returns:
    The formatted string.
    
    Throws:
    
    NullPointerException - if alphaNumericText27 is null.
  - valueOf
```
public static AlphaNumericText27 valueOf(String text)
```
    Parses text from the beginning of the given string to produce an AlphaNumericText27 instance.
    Unlike the parse(String) method this method throws an IllegalArgumentException if text cannot be parsed or is of invalid length.
    
    Parameters:
    text - A formatted string representation of an AlphaNumericText27 instance.
    
    Returns:
    The parsed value.
    
    Throws:
    
    NullPointerException - if text is null.
    
    IllegalArgumentException - if the parse fails or the length of text is greater than 27.

Class AlphaNumericText27

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_LENGTH

Method Detail

charAt

checkAlphaNumeric

compareTo

equals

format

format

hashCode

isEmpty

length

normalize

parse

parse

subSequence

toString

toString

valueOf