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:

java.io.Serializable, java.lang.Comparable<I_CmsResourceType.Formatter>

Enclosing interface:

I_CmsResourceType

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

Resource formatter.

Enum Constant Summary

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

java.lang.String	getDefaultPath() Get the default path.
java.lang.String	getName() Get the name.
static I_CmsResourceType.Formatter	valueOf(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

public static I_CmsResourceType.Formatter valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDefaultPath

public java.lang.String getDefaultPath()

Get the default path.

Returns:

the default path

getName

public java.lang.String getName()

Get the name.

Returns:

the name