com.ibm.as400.ui.util
Class AS400MessageIdFormatter

java.lang.Object
  |
  +--com.ibm.as400.ui.framework.java.DataFormatter
        |
        +--com.ibm.as400.ui.util.AS400Formatter
              |
              +--com.ibm.as400.ui.util.AS400MessageIdFormatter

public class AS400MessageIdFormatter

extends AS400Formatter

Checks validity of a string as an AS/400 Message Id. Checks using the CCSID of the AS/400 specified in the constructor. If parsing is unsuccessful, an IllegalUserDataException is thrown.

A valid AS400 Message Id is:

• exactly 7 characters in length
• first character 'A'-'Z'
• second and third characters 'A'-'Z', '0'-'9'
• last four characters 'A'-'F', '0'-'9'

Wild card processing is defined for an AS/400 Message Id.

Since:

v5r1m0

See Also:

IllegalUserDataException, AS400NameFormatter, AS400SnameFormatter, AS400CnameFormatter, AS400CharFormatter, AS400SQLNameFormatter

Fields inherited from class com.ibm.as400.ui.util.AS400Formatter

ALLOW_EMBEDDED_WILD_CARDS, ALLOW_TRAILING_WILD_CARD, IBM_OBJECT_NAME_MAX_LENGTH, NO_WILD_CARDS, STANDARD_OBJECT_NAME_MAX_LENGTH

Constructor Summary

AS400MessageIdFormatter(AS400 system)
Constructs an AS400MessageIdFormatter.

Method Summary

java.lang.Object

parse(java.lang.String theSource) Parses and checks a string as a valid AS/400 Message Id.

Methods inherited from class com.ibm.as400.ui.util.AS400Formatter

getCCSID, getWildCardMode, isAllowedWildCard, isValidEbcdicAlpha, setCCSID, setWildCardMode

Methods inherited from class com.ibm.as400.ui.framework.java.DataFormatter

format

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AS400MessageIdFormatter

public AS400MessageIdFormatter(AS400 system)

Constructs an AS400MessageIdFormatter. The CCSID of the input AS400 object will be used for checking. If a null AS400 object is used, 37 is used as a default CCSID.

Parameters:

system - an AS400 object.

Since:

v5r1m0

Method Detail

parse

public java.lang.Object parse(java.lang.String theSource)
                       throws IllegalUserDataException

Parses and checks a string as a valid AS/400 Message Id. If the string is not valid an IllegalUserDataException is thrown.

Overrides:

parse in class DataFormatter

Parameters:

source - the string to be parsed

Returns:

the valid checked result

Since:

v5r1m0