Package org.daisy.dotify.api.formatter

Enum MarkerReference.MarkerSearchScope

java.lang.Object

java.lang.Enum<MarkerReference.MarkerSearchScope>

org.daisy.dotify.api.formatter.MarkerReference.MarkerSearchScope

All Implemented Interfaces:

Serializable, Comparable<MarkerReference.MarkerSearchScope>

Enclosing class:

MarkerReference

public static enum MarkerReference.MarkerSearchScope
extends Enum<MarkerReference.MarkerSearchScope>

Defines marker search scopes.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOCUMENT	Defines document search scope.
PAGE	Defines page search scope.
PAGE_CONTENT	Defines page content search scope.
SEQUENCE	Defines sequence search scope.
SHEET	Defines sheet search scope.
SPREAD	Defines spread search scope.
SPREAD_CONTENT	Defines spread content search scope.
VOLUME	Defines volume search scope.

Method Summary

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

public static final MarkerReference.MarkerSearchScope PAGE_CONTENT

Defines page content search scope.

PAGE

public static final MarkerReference.MarkerSearchScope PAGE

Defines page search scope.

SPREAD_CONTENT

public static final MarkerReference.MarkerSearchScope SPREAD_CONTENT

Defines spread content search scope.

SPREAD

public static final MarkerReference.MarkerSearchScope SPREAD

Defines spread search scope.

SHEET

public static final MarkerReference.MarkerSearchScope SHEET

Defines sheet search scope.

SEQUENCE

public static final MarkerReference.MarkerSearchScope SEQUENCE

Defines sequence search scope.

VOLUME

public static final MarkerReference.MarkerSearchScope VOLUME

Defines volume search scope.

DOCUMENT

public static final MarkerReference.MarkerSearchScope DOCUMENT

Defines document search scope.

Method Detail

values

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

Returns:

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

valueOf

public static MarkerReference.MarkerSearchScope 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