com.endeca.infront.cartridge
Enum RefinementMenuConfig.RefinementsShown

java.lang.Object
  java.lang.Enum<RefinementMenuConfig.RefinementsShown>
      com.endeca.infront.cartridge.RefinementMenuConfig.RefinementsShown

All Implemented Interfaces:

Serializable, Comparable<RefinementMenuConfig.RefinementsShown>

Enclosing class:

RefinementMenuConfig

public static enum RefinementMenuConfig.RefinementsShown
extends Enum<RefinementMenuConfig.RefinementsShown>

An enumeration of valid values for RefinementMenuConfig.getRefinementsShown()

Enum Constant Summary

ALL
A navigation refinement menu config that defines "ALL".

NONE
A navigation refinement menu config that defines "none".

SOME
A navigation refinement menu config that defines "some".

Method Summary

static String	configName() The parameter name of the configuration.
static RefinementMenuConfig.RefinementsShown	getValue(String mode) Returns the RefinementMenuConfig.RefinementsShown whose toString() method matches the input argument.
String	toString()
static RefinementMenuConfig.RefinementsShown	valueOf(String name) Returns the enum constant of this type with the specified name.
static RefinementMenuConfig.RefinementsShown[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final RefinementMenuConfig.RefinementsShown NONE

A navigation refinement menu config that defines "none". The "none" value returns 0 refinements in the refinement menu.

SOME

public static final RefinementMenuConfig.RefinementsShown SOME

A navigation refinement menu config that defines "some". The "some" value returns a shortened list of the the refinements. The amount is limited by the RefinementMenuConfig.getNumRefinements() property.

ALL

public static final RefinementMenuConfig.RefinementsShown ALL

A navigation refinement menu config that defines "ALL". The "ALL" value returns ALL refinements. The amount of refinements is limited by the RefinementMenuConfig.getMaxNumRefinements() property.

Method Detail

values

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

Returns:

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

valueOf

public static RefinementMenuConfig.RefinementsShown 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

toString

public String toString()

Overrides:

toString in class Enum<RefinementMenuConfig.RefinementsShown>

Returns:

the lower case string representation of the refinement menu dynamic config

configName

public static String configName()

The parameter name of the configuration.

Returns:

The parameter name of the configuration.

getValue

public static RefinementMenuConfig.RefinementsShown getValue(String mode)

Returns the RefinementMenuConfig.RefinementsShown whose toString() method matches the input argument. If no such RefinementMenuConfig.RefinementsShown is found, throws an IllegalArgumentException.

This method should be used instead of Enum.valueOf(Class, String).