Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class PDFVersion

java.lang.Object

java.lang.Enum<PDFVersion>

org.freedesktop.cairo.PDFVersion

All Implemented Interfaces:

Serializable, Comparable<PDFVersion>, Constable

public enum PDFVersion
extends Enum<PDFVersion>

PDFVersion is used to describe the version number of the PDF specification that a generated PDF file will conform to.

Since:

1.10

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
VERSION_1_4	The version 1.4 of the PDF specification.
VERSION_1_5	The version 1.5 of the PDF specification.
VERSION_1_6	The version 1.6 of the PDF specification.
VERSION_1_7	The version 1.7 of the PDF specification.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Return the value of this enum
static PDFVersion[]	getVersions()	Used to retrieve the list of supported versions.
static PDFVersion	of(int ordinal)	Returns the enum constant for the given ordinal (its position in the enum declaration).
String	toString()	Get the string representation of this version.
static PDFVersion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PDFVersion[]	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

VERSION_1_4

public static final PDFVersion VERSION_1_4

The version 1.4 of the PDF specification.

Since:

1.10

VERSION_1_5

public static final PDFVersion VERSION_1_5

The version 1.5 of the PDF specification.

Since:

1.10

VERSION_1_6

public static final PDFVersion VERSION_1_6

The version 1.6 of the PDF specification.

Since:

1.18

VERSION_1_7

public static final PDFVersion VERSION_1_7

The version 1.7 of the PDF specification.

Since:

1.18

Method Details

values

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

getVersions

public static PDFVersion[] getVersions()

Used to retrieve the list of supported versions. See PDFSurface.restrictToVersion(PDFVersion).

Returns:

supported version list

Since:

1.10

toString

public String toString()

Get the string representation of this version. This function will return null if version isn't valid. See getVersions() for a way to get the list of valid versions.

Overrides:

toString in class Enum<PDFVersion>

Returns:

the string associated this version.

Since:

1.10