com.broadleafcommerce.data.tracking.core.context

Enum ContextIdOverwriteBehavior

java.lang.Object

java.lang.Enum<ContextIdOverwriteBehavior>

com.broadleafcommerce.data.tracking.core.context.ContextIdOverwriteBehavior

All Implemented Interfaces:

Serializable, Comparable<ContextIdOverwriteBehavior>

public enum ContextIdOverwriteBehavior
extends Enum<ContextIdOverwriteBehavior>

Override behaviors for contextId generation for Trackable domain

Author:

Phillip Verheyden (phillipuniverse), Nathan Moore (nathandmoore)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT No override leave it to the rest of the system (specifically the CreateSetupDomainMapperMember) to decide what should be done
DISABLED Prevent overwriting any contextId that was passed in
OVERWRITE Always overwrite the given context id

Method Summary

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

OVERWRITE

public static final ContextIdOverwriteBehavior OVERWRITE

Always overwrite the given context id

DISABLED

public static final ContextIdOverwriteBehavior DISABLED

Prevent overwriting any contextId that was passed in

DEFAULT

public static final ContextIdOverwriteBehavior DEFAULT

No override leave it to the rest of the system (specifically the CreateSetupDomainMapperMember) to decide what should be done

The system by default will look at CreateSetupDomainMapperMember.isOverwriteExistingContextIdOnCreate() and CreateSetupDomainMapperMember.isAutogenerateContextIdIfUnset() to determine the behavior.

Method Detail

values

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

Returns:

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

valueOf

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