Package org.opennms.features.topology.api.support

Enum FocusStrategy

java.lang.Object

java.lang.Enum<FocusStrategy>

org.opennms.features.topology.api.support.FocusStrategy

All Implemented Interfaces:

Serializable, Comparable<FocusStrategy>

public enum FocusStrategy
extends Enum<FocusStrategy>

Different strategies to determine the vertices in Focus.

Author:

mvrueden

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Adds all Vertices to focus.
EMPTY	Empty focus
FIRST	First element is added to focus.
SPECIFIC	The provided list of IDs is added to focus.

Method Summary

Modifier and Type	Method	Description
List<VertexHopCriteria>	getFocusCriteria(BackendGraph graph, String... arguments)
static FocusStrategy	getStrategy(String input, FocusStrategy defaultValue)
static FocusStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FocusStrategy[]	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

EMPTY

public static final FocusStrategy EMPTY

Empty focus

ALL

public static final FocusStrategy ALL

Adds all Vertices to focus.

FIRST

public static final FocusStrategy FIRST

First element is added to focus.

SPECIFIC

public static final FocusStrategy SPECIFIC

The provided list of IDs is added to focus.

Method Detail

values

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

Returns:

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

valueOf

public static FocusStrategy 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

getFocusCriteria

public List<VertexHopCriteria> getFocusCriteria(BackendGraph graph,
                                                String... arguments)

getStrategy

public static FocusStrategy getStrategy(String input,
                                        FocusStrategy defaultValue)