com.exalead.access.feedapi

Enum CategoryTreeContainer.IterationMode

java.lang.Object

java.lang.Enum<CategoryTreeContainer.IterationMode>

com.exalead.access.feedapi.CategoryTreeContainer.IterationMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CategoryTreeContainer.IterationMode>

Enclosing class:

CategoryTreeContainer<T extends AbstractCategory<T>>

public static enum CategoryTreeContainer.IterationMode
extends java.lang.Enum<CategoryTreeContainer.IterationMode>

Controls what kind of iterator is returned by getCategoryIterator() TODO(blindfor): Move logic from iterator(x,y) into here to make more extensible

Author:

blindfor

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Does a 'depth-first', recursive iteration returning all category nodes as they are encountered.
DRILLDOWN Flat which drilldown to direct leaves of refined categories
FLAT Flat, non-recursive, vanilla iterator.
LEAVES Like ALL, but only returns the leaves

Method Summary

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

FLAT

public static final CategoryTreeContainer.IterationMode FLAT

Flat, non-recursive, vanilla iterator.

DRILLDOWN

public static final CategoryTreeContainer.IterationMode DRILLDOWN

Flat which drilldown to direct leaves of refined categories

LEAVES

public static final CategoryTreeContainer.IterationMode LEAVES

Like ALL, but only returns the leaves

ALL

public static final CategoryTreeContainer.IterationMode ALL

Does a 'depth-first', recursive iteration returning all category nodes as they are encountered.

Method Detail

values

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

Returns:

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

valueOf

public static CategoryTreeContainer.IterationMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null