Package org.apache.commons.validator.routines.checkdigit

Class CheckDigitException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.commons.validator.routines.checkdigit.CheckDigitException

All Implemented Interfaces:

Serializable

public class CheckDigitException
extends Exception

Check Digit calculation/validation error.

Since:

1.4

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MISSING_CODE	Common message text when code is Null or empty
static final String	START_WITH_INVALID	Common prefix for messages, f.i.
static final String	ZERO_SUM	Common message text when code sum is zero

Constructor Summary

Constructors

Constructor	Description
CheckDigitException()	Constructs an Exception with no message.
CheckDigitException(String msg)	Constructs an Exception with a message.
CheckDigitException(String msg, Throwable cause)	Constructs an Exception with a message and the underlying cause.

Method Summary

Modifier and Type	Method	Description
static final String	invalidCharacter(char character)	Convenient message text "Invalid Character [character]" without pos
static final String	invalidCharacter(char character, int atPos)	Convenient message text "Invalid Character [character] at pos [atPos]"
static final String	invalidCharacter(String character)	Convenient message text "Invalid Character [character]"
static final String	invalidCode(String code)	Convenient message text "Invalid code [invalidCode]." with no additional information
static final String	invalidCode(String code, String detail)	Convenient message text "Invalid code [invalidCode], additional information", f.i.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

START_WITH_INVALID

public static final String START_WITH_INVALID

Common prefix for messages, f.i. "Invalid Code ...", "Invalid Character ..."

See Also:

• Constant Field Values

MISSING_CODE

public static final String MISSING_CODE

Common message text when code is Null or empty

See Also:

• Constant Field Values

ZERO_SUM

public static final String ZERO_SUM

Common message text when code sum is zero

See Also:

• Constant Field Values

Constructor Details

CheckDigitException

public CheckDigitException()

Constructs an Exception with no message.

CheckDigitException

public CheckDigitException(String msg)

Constructs an Exception with a message.

Parameters:

msg - The error message.

CheckDigitException

public CheckDigitException(String msg,
 Throwable cause)

Constructs an Exception with a message and the underlying cause.

Parameters:

msg - The error message.

cause - The underlying cause of the error

Method Details

invalidCode

public static final String invalidCode(String code)

Convenient message text "Invalid code [invalidCode]." with no additional information

Parameters:

code - the invalid code

Returns:

the message text

invalidCode

public static final String invalidCode(String code,
 String detail)

Convenient message text "Invalid code [invalidCode], additional information", f.i. Invalid code "", too short

Parameters:

code - the invalid code

detail - optional additional information

Returns:

the message text

invalidCharacter

public static final String invalidCharacter(String character)

Convenient message text "Invalid Character [character]"

Parameters:

character - the invalid character string

Returns:

the message text

invalidCharacter

public static final String invalidCharacter(char character)

Convenient message text "Invalid Character [character]" without pos

Parameters:

character - the invalid character

Returns:

the message text

invalidCharacter

public static final String invalidCharacter(char character,
 int atPos)

Convenient message text "Invalid Character [character] at pos [atPos]"

Parameters:

character - the invalid character

atPos - the position of the character in code

Returns:

the message text