Package com.broadleafcommerce.adminnavigation.domain

Enum Class DefaultNavigationPredicateName

java.lang.Object

java.lang.Enum<DefaultNavigationPredicateName>

com.broadleafcommerce.adminnavigation.domain.DefaultNavigationPredicateName

All Implemented Interfaces:

Serializable, Comparable<DefaultNavigationPredicateName>, Constable

public enum DefaultNavigationPredicateName
extends Enum<DefaultNavigationPredicateName>

Defines the default supported NavigationPredicates.

Since:

Admin Navigation 3.0.0, Release Train 3.0.0

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
APPLICATION_BY_ID	Represents the NavigationPredicate used to filter or resolve navigation based on a specific application ID.
APPLICATION_ONLY	Represents a NavigationPredicate used exclusively to filter or resolve navigation based solely on being in an application context without regard for which specific application.
TENANT_BY_ID	Represents the NavigationPredicate used to filter or resolve navigation based on a specific tenant ID.
TENANT_ONLY	Represents a NavigationPredicate used exclusively to filter or resolve navigation based solely on being in an tenant context without regard for which specific tenant.

Method Summary

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

APPLICATION_BY_ID

public static final DefaultNavigationPredicateName APPLICATION_BY_ID

Represents the NavigationPredicate used to filter or resolve navigation based on a specific application ID.

APPLICATION_ONLY

public static final DefaultNavigationPredicateName APPLICATION_ONLY

Represents a NavigationPredicate used exclusively to filter or resolve navigation based solely on being in an application context without regard for which specific application.

TENANT_BY_ID

public static final DefaultNavigationPredicateName TENANT_BY_ID

Represents the NavigationPredicate used to filter or resolve navigation based on a specific tenant ID.

TENANT_ONLY

public static final DefaultNavigationPredicateName TENANT_ONLY

Represents a NavigationPredicate used exclusively to filter or resolve navigation based solely on being in an tenant context without regard for which specific tenant.

Method Details

values

public static DefaultNavigationPredicateName[] 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 DefaultNavigationPredicateName 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