org.gedcomx.types

Enum DocumentType

java.lang.Object

java.lang.Enum<DocumentType>

org.gedcomx.types.DocumentType

All Implemented Interfaces:

Serializable, Comparable<DocumentType>, ControlledVocabulary

public enum DocumentType
extends Enum<DocumentType>
implements ControlledVocabulary

Enumeration of document types.

Author:

Ryan Heaton

Enum Constant Summary

Enum Constants

Enum Constant and Description
Abstract The document is an abstract of a record or document.
Analysis The document is an analysis done by a researcher, often used as a genealogical proof statement.
OTHER
Transcription The document is a transcription (full or partial) of a record or document.
Translation The document is a translation of a record or document.

Method Summary

Modifier and Type	Method and Description
static DocumentType	fromQNameURI(URI qname) Get the enumeration from the QName.
URI	toQNameURI() Return the QName value for this enum.
static DocumentType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentType[]	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

Abstract

public static final DocumentType Abstract

The document is an abstract of a record or document.

Translation

public static final DocumentType Translation

The document is a translation of a record or document.

Transcription

public static final DocumentType Transcription

The document is a transcription (full or partial) of a record or document.

Analysis

public static final DocumentType Analysis

The document is an analysis done by a researcher, often used as a genealogical proof statement.

OTHER

public static final DocumentType OTHER

Method Detail

values

public static DocumentType[] 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 (DocumentType c : DocumentType.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocumentType valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toQNameURI

public URI toQNameURI()

Return the QName value for this enum.

Specified by:

toQNameURI in interface ControlledVocabulary

Returns:

The QName value for this enum.

fromQNameURI

public static DocumentType fromQNameURI(URI qname)

Get the enumeration from the QName.

Parameters:

qname - The qname.

Returns:

The enumeration.