uk.org.blankaspect.nlf
Enum ExceptionId

java.lang.Object
  extended by java.lang.Enum<ExceptionId>
      extended by uk.org.blankaspect.nlf.ExceptionId
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ExceptionId>

public enum ExceptionId
extends java.lang.Enum<ExceptionId>

This enumeration contains identifiers for the Nested List File exceptions NlfException and NlfUncheckedException. Each identifier maps to a message.

Since:
1.0

Enum Constant Summary
ADDING_ANCESTOR_NOT_ALLOWED
           
CHUNK_SIZE_OUT_OF_BOUNDS
           
DIFFERENT_DOCUMENTS
           
ERROR_ENCODING_CHUNK_DATA
           
ERROR_GENERATING_XML_DOCUMENT
           
ERROR_READING_FILE
           
ERROR_WRITING_FILE
           
FAILED_TO_CLOSE_FILE
           
FAILED_TO_CREATE_TEMPORARY_FILE
           
FAILED_TO_CREATE_XML_DOCUMENT
           
FAILED_TO_DELETE_FILE
           
FAILED_TO_LOCK_FILE
           
FAILED_TO_OPEN_FILE
           
FAILED_TO_RENAME_FILE
           
FILE_ACCESS_NOT_PERMITTED
           
FILE_IS_OPEN_ON_DOCUMENT
           
INVALID_ATTRIBUTE_NAME
           
INVALID_ATTRIBUTE_VALUE
           
INVALID_CHUNK_ID
           
INVALID_LIST_INSTANCE_ID
           
INVALID_NAMESPACE_NAME
           
INVALID_VERSION_NUM
           
MALFORMED_ATTRIBUTES_CHUNK
           
MALFORMED_FILE
           
MULTIPLE_ATTRIBUTES
           
MULTIPLE_ATTRIBUTES_CHUNKS
           
NO_ROOT_LIST
           
NOT_A_NESTED_LIST_FILE
           
NOT_ENOUGH_MEMORY
           
OPERATION_TERMINATED
           
RESERVED_IDENTIFIER
           
UNSUPPORTED_VERSION
           
UTF8_ENCODING_NOT_SUPPORTED
           
 
Method Summary
 java.lang.String getMessage()
          Returns the message that the exception identifier maps to.
static ExceptionId valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ExceptionId[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FAILED_TO_OPEN_FILE

public static final ExceptionId FAILED_TO_OPEN_FILE

FAILED_TO_CLOSE_FILE

public static final ExceptionId FAILED_TO_CLOSE_FILE

FAILED_TO_LOCK_FILE

public static final ExceptionId FAILED_TO_LOCK_FILE

ERROR_READING_FILE

public static final ExceptionId ERROR_READING_FILE

ERROR_WRITING_FILE

public static final ExceptionId ERROR_WRITING_FILE

FILE_ACCESS_NOT_PERMITTED

public static final ExceptionId FILE_ACCESS_NOT_PERMITTED

FAILED_TO_CREATE_TEMPORARY_FILE

public static final ExceptionId FAILED_TO_CREATE_TEMPORARY_FILE

FAILED_TO_DELETE_FILE

public static final ExceptionId FAILED_TO_DELETE_FILE

FAILED_TO_RENAME_FILE

public static final ExceptionId FAILED_TO_RENAME_FILE

NOT_A_NESTED_LIST_FILE

public static final ExceptionId NOT_A_NESTED_LIST_FILE

INVALID_VERSION_NUM

public static final ExceptionId INVALID_VERSION_NUM

UNSUPPORTED_VERSION

public static final ExceptionId UNSUPPORTED_VERSION

NO_ROOT_LIST

public static final ExceptionId NO_ROOT_LIST

MALFORMED_FILE

public static final ExceptionId MALFORMED_FILE

INVALID_CHUNK_ID

public static final ExceptionId INVALID_CHUNK_ID

CHUNK_SIZE_OUT_OF_BOUNDS

public static final ExceptionId CHUNK_SIZE_OUT_OF_BOUNDS

INVALID_LIST_INSTANCE_ID

public static final ExceptionId INVALID_LIST_INSTANCE_ID

INVALID_NAMESPACE_NAME

public static final ExceptionId INVALID_NAMESPACE_NAME

MULTIPLE_ATTRIBUTES_CHUNKS

public static final ExceptionId MULTIPLE_ATTRIBUTES_CHUNKS

MALFORMED_ATTRIBUTES_CHUNK

public static final ExceptionId MALFORMED_ATTRIBUTES_CHUNK

INVALID_ATTRIBUTE_NAME

public static final ExceptionId INVALID_ATTRIBUTE_NAME

INVALID_ATTRIBUTE_VALUE

public static final ExceptionId INVALID_ATTRIBUTE_VALUE

MULTIPLE_ATTRIBUTES

public static final ExceptionId MULTIPLE_ATTRIBUTES

FAILED_TO_CREATE_XML_DOCUMENT

public static final ExceptionId FAILED_TO_CREATE_XML_DOCUMENT

ERROR_GENERATING_XML_DOCUMENT

public static final ExceptionId ERROR_GENERATING_XML_DOCUMENT

OPERATION_TERMINATED

public static final ExceptionId OPERATION_TERMINATED

NOT_ENOUGH_MEMORY

public static final ExceptionId NOT_ENOUGH_MEMORY

UTF8_ENCODING_NOT_SUPPORTED

public static final ExceptionId UTF8_ENCODING_NOT_SUPPORTED

RESERVED_IDENTIFIER

public static final ExceptionId RESERVED_IDENTIFIER

FILE_IS_OPEN_ON_DOCUMENT

public static final ExceptionId FILE_IS_OPEN_ON_DOCUMENT

DIFFERENT_DOCUMENTS

public static final ExceptionId DIFFERENT_DOCUMENTS

ADDING_ANCESTOR_NOT_ALLOWED

public static final ExceptionId ADDING_ANCESTOR_NOT_ALLOWED

ERROR_ENCODING_CHUNK_DATA

public static final ExceptionId ERROR_ENCODING_CHUNK_DATA
Method Detail

values

public static ExceptionId[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ExceptionId c : ExceptionId.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExceptionId valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getMessage

public java.lang.String getMessage()
Returns the message that the exception identifier maps to.

Returns:
the message that the exception identifier maps to.
Since:
1.0