lumis.portal.page.cache

Enum IPageCacheManager.GenerationOutcome

java.lang.Object

java.lang.Enum<IPageCacheManager.GenerationOutcome>

lumis.portal.page.cache.IPageCacheManager.GenerationOutcome

All Implemented Interfaces:

Serializable, Comparable<IPageCacheManager.GenerationOutcome>

Enclosing interface:

IPageCacheManager

public static enum IPageCacheManager.GenerationOutcome
extends Enum<IPageCacheManager.GenerationOutcome>

Indicates the outcome of a page generation.

Since:

4.1.0

Version:

$Revision: 20807 $ $Date: 2017-11-30 19:08:51 +0000 (Thu, 30 Nov 2017) $

See Also:

IPageCacheManager#releaseGenerationLock(PageCacheConfig, int)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCEL The generation was not completed and should be considered canceled.
ERROR The generation could not be completed due to an error.
SUCCESS The generation was completed with success.
UNPUBLISH The generation could not be completed and the cache should be set to PageCacheConfig.STATUS_NOT_PUBLISHED.

Method Summary

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

SUCCESS

public static final IPageCacheManager.GenerationOutcome SUCCESS

The generation was completed with success.

Since:

4.1.0

ERROR

public static final IPageCacheManager.GenerationOutcome ERROR

The generation could not be completed due to an error.

Since:

4.1.0

CANCEL

public static final IPageCacheManager.GenerationOutcome CANCEL

The generation was not completed and should be considered canceled.

Since:

4.1.0

UNPUBLISH

public static final IPageCacheManager.GenerationOutcome UNPUBLISH

The generation could not be completed and the cache should be set to PageCacheConfig.STATUS_NOT_PUBLISHED.

Since:

10.2.0

Method Detail

values

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

Returns:

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

valueOf

public static IPageCacheManager.GenerationOutcome 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