Package com.broadleafcommerce.search.api.type

Enum Class DefaultSettingsContextType

java.lang.Object

java.lang.Enum<DefaultSettingsContextType>

com.broadleafcommerce.search.api.type.DefaultSettingsContextType

All Implemented Interfaces:

Serializable, Comparable<DefaultSettingsContextType>, Constable

public enum DefaultSettingsContextType
extends Enum<DefaultSettingsContextType>

Defines the default contexts for SearchSettings.

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
ADMIN
STOREFRONT

Method Summary

Modifier and Type	Method	Description
static DefaultSettingsContextType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultSettingsContextType[]	values()	Returns an array containing the constants of this enum class, 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

ADMIN

public static final DefaultSettingsContextType ADMIN

STOREFRONT

public static final DefaultSettingsContextType STOREFRONT

Method Details

values

public static DefaultSettingsContextType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DefaultSettingsContextType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null