com.uc4.api

Class InvalidUC4NameException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.uc4.api.InvalidUC4NameException

All Implemented Interfaces:

Serializable

public class InvalidUC4NameException
extends RuntimeException

This runtime exception is thrown if the name of an object is invalid. The getInvalidName() method returns and the invalid name.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidUC4NameException(String invalidName) Constructs an InvalidUC4NameException using the specified name.
InvalidUC4NameException(String invalidName, String allowedCharacters, int maxLength) Constructs an InvalidUC4NameException using the specified name.

Method Summary

Modifier and Type	Method and Description
String	getAllowedCharacters() Returns the allowed characters.
String	getInvalidName() Returns the invalid name.
int	getMaxLength() Returns the maximal allowed length of the name or zero if no restriction is set.
String	getMessage()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidUC4NameException

public InvalidUC4NameException(String invalidName)

Constructs an InvalidUC4NameException using the specified name.

Parameters:

invalidName - name

InvalidUC4NameException

public InvalidUC4NameException(String invalidName,
                               String allowedCharacters,
                               int maxLength)

Constructs an InvalidUC4NameException using the specified name.

Parameters:

invalidName - name

allowedCharacters - allowed characters, use empty string if all characters are allowed

maxLength - maximal allowed length, use 0 if no length restriction is given

Method Detail

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getInvalidName

public String getInvalidName()

Returns the invalid name.

Returns:

name

getAllowedCharacters

public String getAllowedCharacters()

Returns the allowed characters. Empty if no restriction is set.

Returns:

allowed characters

getMaxLength

public int getMaxLength()

Returns the maximal allowed length of the name or zero if no restriction is set.

Returns:

length