DocumentCategory (id3 Document Toolkit 2.1.2 JavaAPI Reference)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentCategory>
```
public enum DocumentCategory
extends java.lang.Enum<DocumentCategory>
```
Enumerates document categories.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`A` Passport
`B` Identity card
`C` Visa
`D` Stamp
`E` Entry paper
`F` Driving licence
`G` Vehicle licence/ log book
`H` Residence-related document
`I` Seafarers' identity document
`J` Travel document issued to non-nationals
`K` Train driving licence
`L` Crew member certificate / pilot's licence
`M` Certificate for operators of pleasure crafts / captain's licence
`P` Civil status/ other official document
`S` Special authorisation card
`T` Travel document
`UNKNOWN` Unknown document category.
`V` Authorisation to represent a company
`W` Work permit
`X` Other document

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentCategory`	`fromValue(int value)` Creates an enumeration value from int.
`int`	`getValue()` Gets the enumeration value as int.
`static DocumentCategory`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DocumentCategory[]`	`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
  - UNKNOWN
```
public static final DocumentCategory UNKNOWN
```
    Unknown document category.
  - A
```
public static final DocumentCategory A
```
    Passport
  - B
```
public static final DocumentCategory B
```
    Identity card
  - C
```
public static final DocumentCategory C
```
    Visa
  - D
```
public static final DocumentCategory D
```
    Stamp
  - E
```
public static final DocumentCategory E
```
    Entry paper
  - F
```
public static final DocumentCategory F
```
    Driving licence
  - G
```
public static final DocumentCategory G
```
    Vehicle licence/ log book
  - H
```
public static final DocumentCategory H
```
    Residence-related document
  - I
```
public static final DocumentCategory I
```
    Seafarers' identity document
  - J
```
public static final DocumentCategory J
```
    Travel document issued to non-nationals
  - K
```
public static final DocumentCategory K
```
    Train driving licence
  - L
```
public static final DocumentCategory L
```
    Crew member certificate / pilot's licence
  - M
```
public static final DocumentCategory M
```
    Certificate for operators of pleasure crafts / captain's licence
  - P
```
public static final DocumentCategory P
```
    Civil status/ other official document
  - S
```
public static final DocumentCategory S
```
    Special authorisation card
  - T
```
public static final DocumentCategory T
```
    Travel document
  - V
```
public static final DocumentCategory V
```
    Authorisation to represent a company
  - W
```
public static final DocumentCategory W
```
    Work permit
  - X
```
public static final DocumentCategory X
```
    Other document
- Method Detail
  - values
```
public static DocumentCategory[] 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 (DocumentCategory c : DocumentCategory.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DocumentCategory 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 DocumentCategory fromValue(int value)
```
    Creates an enumeration value from int.
    
    Parameters:
    
    value - The int value.
    
    Returns:
    
    The created DocumentCategory.

Enum DocumentCategory

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNKNOWN

A

B

C

D

E

F

G

H

I

J

K

L

M

P

S

T

V

W

X

Method Detail

values

valueOf

getValue

fromValue