Package org.apache.juneau.console.views

Enum Class BadgeDef.ScopeBy

java.lang.Object

java.lang.Enum<BadgeDef.ScopeBy>

org.apache.juneau.console.views.BadgeDef.ScopeBy

All Implemented Interfaces:

Serializable, Comparable<BadgeDef.ScopeBy>, Constable

Enclosing class:

BadgeDef

public static enum BadgeDef.ScopeBy
extends Enum<BadgeDef.ScopeBy>

scope.by wire tokens.

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
NAV	Keys on the leaf of the page's activeNav.
VIEW	Keys on the active tab of the card named by BadgeDef.table.

Method Summary

Modifier and Type	Method	Description
static BadgeDef.ScopeBy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BadgeDef.ScopeBy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
String	wire()

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

NAV

public static final BadgeDef.ScopeBy NAV

Keys on the leaf of the page's activeNav.

VIEW

public static final BadgeDef.ScopeBy VIEW

Keys on the active tab of the card named by BadgeDef.table.

Method Details

values

public static BadgeDef.ScopeBy[] 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 BadgeDef.ScopeBy 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

wire

public String wire()

Returns:

The lowercase wire token (e.g. "nav").