Package org.opencms.xml.containerpage

Enum Class CmsFormatterBean.ContentExtractionPolicy

java.lang.Object

java.lang.Enum<CmsFormatterBean.ContentExtractionPolicy>

org.opencms.xml.containerpage.CmsFormatterBean.ContentExtractionPolicy

All Implemented Interfaces:

Serializable, Comparable<CmsFormatterBean.ContentExtractionPolicy>, Constable

Enclosing class:

CmsFormatterBean

public static enum CmsFormatterBean.ContentExtractionPolicy
extends Enum<CmsFormatterBean.ContentExtractionPolicy>

The valid values of the content extraction policy (CmsFormatterBean.getContentExtractionPolicy()).

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
SEARCH_ONLY	Index the content for search, but keep it out of content extraction (e.g.
SUMMARY_ONLY	Use the content for summaries only.

Method Summary

Modifier and Type	Method	Description
static CmsFormatterBean.ContentExtractionPolicy	forValue(String value)	Returns the policy for a configured string value, or null if none matches.
String	getValue()	Returns the configured string value.
static CmsFormatterBean.ContentExtractionPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CmsFormatterBean.ContentExtractionPolicy[]	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

SEARCH_ONLY

public static final CmsFormatterBean.ContentExtractionPolicy SEARCH_ONLY

Index the content for search, but keep it out of content extraction (e.g. the page outline).

SUMMARY_ONLY

public static final CmsFormatterBean.ContentExtractionPolicy SUMMARY_ONLY

Use the content for summaries only.

Method Details

values

public static CmsFormatterBean.ContentExtractionPolicy[] 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 CmsFormatterBean.ContentExtractionPolicy 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

forValue

public static CmsFormatterBean.ContentExtractionPolicy forValue(String value)

Returns the policy for a configured string value, or null if none matches.

Parameters:

value - the configured string value

Returns:

the matching policy, or null

getValue

public String getValue()

Returns the configured string value.

Returns:

the configured string value