com.ironsoftware.ironpdf.bookmark

Enum BookmarkDestinations

java.lang.Object

java.lang.Enum<BookmarkDestinations>

com.ironsoftware.ironpdf.bookmark.BookmarkDestinations

All Implemented Interfaces:

Serializable, Comparable<BookmarkDestinations>

public enum BookmarkDestinations
extends Enum<BookmarkDestinations>

A class allowing for future implementations of Bookmark to link to places other than PDF pages.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PAGE

Method Summary

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

PAGE

public static final BookmarkDestinations PAGE

Method Detail

values

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

Returns:

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

valueOf

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