Package org.opencms.publish

Enum CmsPublishManager.PublishListRemoveMode

java.lang.Object

java.lang.Enum<CmsPublishManager.PublishListRemoveMode>

org.opencms.publish.CmsPublishManager.PublishListRemoveMode

All Implemented Interfaces:

Serializable, Comparable<CmsPublishManager.PublishListRemoveMode>, java.lang.constant.Constable

Enclosing class:

CmsPublishManager

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

Enum for the different publish list remove modes.

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
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	Description
static CmsPublishManager.PublishListRemoveMode	valueOf(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, 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

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 Details

values

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