org.broadleafcommerce.common.extension

Enum ExtensionResultStatusType

java.lang.Object

java.lang.Enum<ExtensionResultStatusType>

org.broadleafcommerce.common.extension.ExtensionResultStatusType

All Implemented Interfaces:

Serializable, Comparable<ExtensionResultStatusType>

public enum ExtensionResultStatusType
extends Enum<ExtensionResultStatusType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
HANDLED In short, this value should only be returned from ExtensionManagers and not from ExtensionHandlers.
HANDLED_CONTINUE The extension was handled by the ExtensionHandler and it recommends continuing with additional ExtensionHandlers (if more are available).
HANDLED_STOP An ExtensionHandler has handled this and it recommends that the ExtensionManager should not invoke any more ExtensionHandlers that it may have to execute
NOT_HANDLED This was not handled by the ExtensionHandler.

Method Summary

Methods

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

HANDLED

public static final ExtensionResultStatusType HANDLED

In short, this value should only be returned from ExtensionManagers and not from ExtensionHandlers.

When you are returning results from an ExtensionHandler then it is less ambiguous to ExtensionManagers to instead return HANDLED_CONTINUE or HANDLED_CONTINUE instead. However, when checking the result of invoking an ExtensionManager to see if it was handled by ANY ExtensionHandler then it makes sense to return this enum instead

HANDLED_CONTINUE

public static final ExtensionResultStatusType HANDLED_CONTINUE

The extension was handled by the ExtensionHandler and it recommends continuing with additional ExtensionHandlers (if more are available).

HANDLED_STOP

public static final ExtensionResultStatusType HANDLED_STOP

An ExtensionHandler has handled this and it recommends that the ExtensionManager should not invoke any more ExtensionHandlers that it may have to execute

NOT_HANDLED

public static final ExtensionResultStatusType NOT_HANDLED

This was not handled by the ExtensionHandler. In the context of the result of an ExtensionManager, this indicates that it was not executed by any of the registered ExtensionHandlers, or that none were registered in the first place

Method Detail

values

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

Returns:

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

valueOf

public static ExtensionResultStatusType 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