Package edu.harvard.hul.ois.jhove

Enum Class DocumentType

java.lang.Object

java.lang.Enum<DocumentType>

edu.harvard.hul.ois.jhove.DocumentType

All Implemented Interfaces:

Serializable, Comparable<DocumentType>, java.lang.constant.Constable

public enum DocumentType
extends Enum<DocumentType>

This class defines enumerated types for a Document. Applications will not create or modify DocumentTypes, but will use one of the predefined DocumentType instances ARTICLE, BOOK, REPORT, RFC, STANDARD, WEB, or OTHER.

See Also:

• Document

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARTICLE	Document type for a printed article.
BOOK	Document type for an book.
OTHER	Document type that doesn't fit the other categories.
REPORT	Document type for a report.
RFC	Document type for an IETF Request for Comment.
STANDARD	Document type for a standards body publication.
WEB	Document type for a Web page.

Field Summary

Fields

Modifier and Type	Field	Description
final String	name	A String name for the type, used for reporting.

Method Summary

Modifier and Type	Method	Description
String	toString()
static DocumentType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARTICLE

public static final DocumentType ARTICLE

Document type for a printed article.

BOOK

public static final DocumentType BOOK

Document type for an book.

REPORT

public static final DocumentType REPORT

Document type for a report.

RFC

public static final DocumentType RFC

Document type for an IETF Request for Comment.

STANDARD

public static final DocumentType STANDARD

Document type for a standards body publication.

WEB

public static final DocumentType WEB

Document type for a Web page.

OTHER

public static final DocumentType OTHER

Document type that doesn't fit the other categories.

Field Details

name

public final String name

A String name for the type, used for reporting.

Method Details

values

public static DocumentType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DocumentType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<DocumentType>