org.sejda.model.pdf

Enum PdfMetadataKey

java.lang.Object

java.lang.Enum<PdfMetadataKey>

org.sejda.model.pdf.PdfMetadataKey

All Implemented Interfaces:

Serializable, Comparable<PdfMetadataKey>

public enum PdfMetadataKey
extends Enum<PdfMetadataKey>

Possible metadata key used to set metadata values on a document.

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHOR
CREATOR
KEYWORDS
SUBJECT
TITLE

Method Summary

Methods

Modifier and Type	Method and Description
String	getKey()
static PdfMetadataKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static PdfMetadataKey[]	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

TITLE

public static final PdfMetadataKey TITLE

AUTHOR

public static final PdfMetadataKey AUTHOR

SUBJECT

public static final PdfMetadataKey SUBJECT

KEYWORDS

public static final PdfMetadataKey KEYWORDS

CREATOR

public static final PdfMetadataKey CREATOR

Method Detail

values

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

Returns:

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

valueOf

public static PdfMetadataKey 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

getKey

public String getKey()

Returns:

the metadata key