org.broadleafcommerce.openadmin.server.service.type

Enum FieldProviderResponse

java.lang.Object

java.lang.Enum<FieldProviderResponse>

org.broadleafcommerce.openadmin.server.service.type.FieldProviderResponse

All Implemented Interfaces:

Serializable, Comparable<FieldProviderResponse>

public enum FieldProviderResponse
extends Enum<FieldProviderResponse>

For FieldMetadataProvider and FieldPersistenceProvider, message the system on how it should interpret the provider's handling of the call. If HANDLED, then the system will consider that a valid provider was found for the request, and subsequently not call the default provider. If all registered providers respond with NOT_HANDLED, then the default provider is called. If HANDLED_BREAK is returned, then the provider loop is immediately exited and the default provider is not called.

In combination with the Ordered, this provides a way for a provider to either override existing behavior by setting a low order and returning HANDLED_BREAK, or add to behavior by setting any order and returning HANDLED.

Author:

Jeff Fischer

Enum Constant Summary

Enum Constants

Enum Constant and Description
HANDLED
HANDLED_BREAK
NOT_HANDLED

Method Summary

Methods

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

NOT_HANDLED

public static final FieldProviderResponse NOT_HANDLED

HANDLED_BREAK

public static final FieldProviderResponse HANDLED_BREAK

Method Detail

values

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

Returns:

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

valueOf

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