Package org.opencms.file.types

Enum I_CmsResourceType.Formatter

java.lang.Object

java.lang.Enum<I_CmsResourceType.Formatter>

org.opencms.file.types.I_CmsResourceType.Formatter

All Implemented Interfaces:

Serializable, Comparable<I_CmsResourceType.Formatter>, java.lang.constant.Constable

Enclosing interface:

I_CmsResourceType

public static enum I_CmsResourceType.Formatter
extends Enum<I_CmsResourceType.Formatter>

Resource formatter.

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
ADE_LIST	The gallery list item formatter.
GALLERY_LIST	The gallery list item formatter.
GALLERY_PREVIEW	The gallery preview formatter.
PUBLISH_LIST	The gallery list item formatter.
SITEMAP	The sitemap formatter.

Method Summary

Modifier and Type	Method	Description
String	getDefaultPath()	Get the default path.
String	getName()	Get the name.
static I_CmsResourceType.Formatter	valueOf(String name)	Returns the enum constant of this type with the specified name.
static I_CmsResourceType.Formatter[]	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, 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

ADE_LIST

public static final I_CmsResourceType.Formatter ADE_LIST

The gallery list item formatter.

GALLERY_LIST

public static final I_CmsResourceType.Formatter GALLERY_LIST

The gallery list item formatter.

GALLERY_PREVIEW

public static final I_CmsResourceType.Formatter GALLERY_PREVIEW

The gallery preview formatter.

PUBLISH_LIST

public static final I_CmsResourceType.Formatter PUBLISH_LIST

The gallery list item formatter.

SITEMAP

public static final I_CmsResourceType.Formatter SITEMAP

The sitemap formatter.

Method Details

values

public static I_CmsResourceType.Formatter[] values()

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

Returns:

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

valueOf

public static I_CmsResourceType.Formatter 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

getDefaultPath

public String getDefaultPath()

Get the default path.

Returns:

the default path

getName

public String getName()

Get the name.

Returns:

the name