Module com.semanticcms.core.servlet

Package com.semanticcms.core.servlet

Enum CaptureLevel

java.lang.Object

java.lang.Enum<CaptureLevel>

com.semanticcms.core.servlet.CaptureLevel

All Implemented Interfaces:

Serializable, Comparable<CaptureLevel>

public enum CaptureLevel
extends Enum<CaptureLevel>

The capture modes.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BODY	Captures everything: page meta data, content meta data, and all body content.
META	Captures both page and content meta data.
PAGE	Captures page meta data only, such as title, copyright, authors, parents, and children.

Method Summary

Modifier and Type	Method	Description
static CaptureLevel	getCaptureLevel(ServletRequest request)	Gets the capture level or BODY if none occurring.
static CaptureLevel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CaptureLevel[]	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 CaptureLevel PAGE

Captures page meta data only, such as title, copyright, authors, parents, and children.

META

public static final CaptureLevel META

Captures both page and content meta data.

BODY

public static final CaptureLevel BODY

Captures everything: page meta data, content meta data, and all body content.

Method Detail

values

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

Returns:

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

valueOf

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

getCaptureLevel

public static CaptureLevel getCaptureLevel(ServletRequest request)

Gets the capture level or BODY if none occurring.