Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class PDFMetadata

java.lang.Object

java.lang.Enum<PDFMetadata>

org.freedesktop.cairo.PDFMetadata

All Implemented Interfaces:

Serializable, Comparable<PDFMetadata>, Constable

public enum PDFMetadata
extends Enum<PDFMetadata>

PDFMetadata is used by the cairo_pdf_surface_set_metadata() function specify the metadata to set.

Since:

1.16

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
AUTHOR	The document author
CREATE_DATE	The document creation date
CREATOR	The document creator
KEYWORDS	The document keywords
MOD_DATE	The document modification date
SUBJECT	The document subject
TITLE	The document title

Method Summary

Modifier and Type	Method	Description
int	getValue()	Return the value of this enum
static PDFMetadata	of(int ordinal)	Returns the enum constant for the given ordinal (its position in the enum declaration).
static PDFMetadata	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PDFMetadata[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TITLE

public static final PDFMetadata TITLE

The document title

Since:

1.16

AUTHOR

public static final PDFMetadata AUTHOR

The document author

Since:

1.16

SUBJECT

public static final PDFMetadata SUBJECT

The document subject

Since:

1.16

KEYWORDS

public static final PDFMetadata KEYWORDS

The document keywords

Since:

1.16

CREATOR

public static final PDFMetadata CREATOR

The document creator

Since:

1.16

CREATE_DATE

public static final PDFMetadata CREATE_DATE

The document creation date

Since:

1.16

MOD_DATE

public static final PDFMetadata MOD_DATE

The document modification date

Since:

1.16

Method Details

values

public static PDFMetadata[] 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 PDFMetadata 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

getValue

public int getValue()

Return the value of this enum

Returns:

the value

of

public static PDFMetadata of(int ordinal)

Returns the enum constant for the given ordinal (its position in the enum declaration).

Parameters:

ordinal - the position in the enum declaration, starting from zero

Returns:

the enum constant for the given ordinal