org.opencms.publish

Enum CmsPublishManager.PublishListRemoveMode

java.lang.Object

java.lang.Enum<CmsPublishManager.PublishListRemoveMode>

org.opencms.publish.CmsPublishManager.PublishListRemoveMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsPublishManager.PublishListRemoveMode>

Enclosing class:

CmsPublishManager

public static enum CmsPublishManager.PublishListRemoveMode
extends java.lang.Enum<CmsPublishManager.PublishListRemoveMode>

Enum for the different publish list remove modes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
allUsers Remove publish list entries for all users if a resource is published.
currentUser Remove publish list entry for the current user if a resource is published.

Method Summary

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

allUsers

public static final CmsPublishManager.PublishListRemoveMode allUsers

Remove publish list entries for all users if a resource is published.

currentUser

public static final CmsPublishManager.PublishListRemoveMode currentUser

Remove publish list entry for the current user if a resource is published.

Method Detail

values

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

Returns:

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

valueOf

public static CmsPublishManager.PublishListRemoveMode 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