DocumentError (id3 Document Toolkit 2.1.2 JavaAPI Reference)

java.lang.Object
- java.lang.Enum<DocumentError>
- - eu.id3.document.DocumentError

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentError>
```
public enum DocumentError
extends java.lang.Enum<DocumentError>
```
Enumerates possible error codes.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BACKEND_ERROR` One of our computation backends failed for unknown reasons.
`BASE` Base error code of the Document module.
`FUNCTION_NOT_IMPLEMENTED` This function is not implemented.
`INFERENCE_BACKEND_ERROR` The inference backend failed to infer, probably due to inconsistent input.
`INSUFFICIENT_BUFFER` The given buffer is too small.
`INSUFFICIENT_FRAME_NUMBER` The frame buffer is not full, and computation is not allowed.
`INVALID_DOCUMENT_TEMPLATE_FORMAT` The format of the document template is invalid.
`INVALID_DOCUMENT_TEMPLATE_PATH` The document template could not be found at the given path.
`INVALID_HANDLE` The handle is invalid.
`INVALID_MODEL_PATH` The model could not be found in the given directory path.
`INVALID_PARAMETER` The parameter is invalid.
`INVALID_PIXEL_FORMAT` The image pixel format is invalid.
`MINIMUM` Minimum error code of the Document module.
`OBJECT_DOES_NOT_EXIST` The requested object does not exist; a 'null' should be returned if possible.
`PROCESSING_UNIT_UNAVAILABLE` The requested processing unit is not available in this build.
`SUCCESS` No error.
`UNKNOWN_ANNOTATION` The required element is not present in the document annotation.
`UNLOADED_DOCUMENT_TEMPLATE` The document template required for this operation has not been loaded.
`UNLOADED_MODEL` The model which is required for this operation has not been loaded.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentError`	`fromValue(int value)` Creates an enumeration value from int.
`int`	`getValue()` Gets the enumeration value as int.
`static DocumentError`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DocumentError[]`	`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
  - SUCCESS
```
public static final DocumentError SUCCESS
```
    No error.
  - INSUFFICIENT_BUFFER
```
public static final DocumentError INSUFFICIENT_BUFFER
```
    The given buffer is too small.
  - OBJECT_DOES_NOT_EXIST
```
public static final DocumentError OBJECT_DOES_NOT_EXIST
```
    The requested object does not exist; a 'null' should be returned if possible.
  - BASE
```
public static final DocumentError BASE
```
    Base error code of the Document module.
  - MINIMUM
```
public static final DocumentError MINIMUM
```
    Minimum error code of the Document module.
  - INVALID_HANDLE
```
public static final DocumentError INVALID_HANDLE
```
    The handle is invalid.
  - INVALID_PARAMETER
```
public static final DocumentError INVALID_PARAMETER
```
    The parameter is invalid.
  - INVALID_PIXEL_FORMAT
```
public static final DocumentError INVALID_PIXEL_FORMAT
```
    The image pixel format is invalid.
  - INVALID_MODEL_PATH
```
public static final DocumentError INVALID_MODEL_PATH
```
    The model could not be found in the given directory path.
  - INVALID_DOCUMENT_TEMPLATE_PATH
```
public static final DocumentError INVALID_DOCUMENT_TEMPLATE_PATH
```
    The document template could not be found at the given path.
  - UNLOADED_MODEL
```
public static final DocumentError UNLOADED_MODEL
```
    The model which is required for this operation has not been loaded.
  - UNLOADED_DOCUMENT_TEMPLATE
```
public static final DocumentError UNLOADED_DOCUMENT_TEMPLATE
```
    The document template required for this operation has not been loaded.
  - UNKNOWN_ANNOTATION
```
public static final DocumentError UNKNOWN_ANNOTATION
```
    The required element is not present in the document annotation.
  - INVALID_DOCUMENT_TEMPLATE_FORMAT
```
public static final DocumentError INVALID_DOCUMENT_TEMPLATE_FORMAT
```
    The format of the document template is invalid.
  - INSUFFICIENT_FRAME_NUMBER
```
public static final DocumentError INSUFFICIENT_FRAME_NUMBER
```
    The frame buffer is not full, and computation is not allowed.
  - BACKEND_ERROR
```
public static final DocumentError BACKEND_ERROR
```
    One of our computation backends failed for unknown reasons.
  - INFERENCE_BACKEND_ERROR
```
public static final DocumentError INFERENCE_BACKEND_ERROR
```
    The inference backend failed to infer, probably due to inconsistent input.
  - PROCESSING_UNIT_UNAVAILABLE
```
public static final DocumentError PROCESSING_UNIT_UNAVAILABLE
```
    The requested processing unit is not available in this build.
  - FUNCTION_NOT_IMPLEMENTED
```
public static final DocumentError FUNCTION_NOT_IMPLEMENTED
```
    This function is not implemented.
- Method Detail
  - values
```
public static DocumentError[] 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 (DocumentError c : DocumentError.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DocumentError 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
  - getValue
```
public int getValue()
```
    Gets the enumeration value as int.
    
    Returns:
    
    The value.
  - fromValue
```
public static DocumentError fromValue(int value)
```
    Creates an enumeration value from int.
    
    Parameters:
    
    value - The int value.
    
    Returns:
    
    The created DocumentError.

Enum DocumentError

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SUCCESS

INSUFFICIENT_BUFFER

OBJECT_DOES_NOT_EXIST

BASE

MINIMUM

INVALID_HANDLE

INVALID_PARAMETER

INVALID_PIXEL_FORMAT

INVALID_MODEL_PATH

INVALID_DOCUMENT_TEMPLATE_PATH

UNLOADED_MODEL

UNLOADED_DOCUMENT_TEMPLATE

UNKNOWN_ANNOTATION

INVALID_DOCUMENT_TEMPLATE_FORMAT

INSUFFICIENT_FRAME_NUMBER

BACKEND_ERROR

INFERENCE_BACKEND_ERROR

PROCESSING_UNIT_UNAVAILABLE

FUNCTION_NOT_IMPLEMENTED

Method Detail

values

valueOf

getValue

fromValue