org.lsst.ccs.commons.annotations

Enum LookupField.Strategy

java.lang.Object

java.lang.Enum<LookupField.Strategy>

org.lsst.ccs.commons.annotations.LookupField.Strategy

All Implemented Interfaces:

Serializable, Comparable<LookupField.Strategy>

Enclosing class:

LookupField

public static enum LookupField.Strategy
extends Enum<LookupField.Strategy>

Defines the tree travel strategy.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANCESTORS Travels from parent to parent.
BYNAME Deprecated. it should not be used.
CHILDREN Travels the direct children.
DESCENDANTS Travels all the descendants components.
SIBLINGS Travels the siblings.
TOP Sets the annotated field to the top component of the component tree, which is the enclosing subsystem.
TREE Travels the whole component tree.

Method Summary

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

ANCESTORS

public static final LookupField.Strategy ANCESTORS

Travels from parent to parent.

DESCENDANTS

public static final LookupField.Strategy DESCENDANTS

Travels all the descendants components.

CHILDREN

public static final LookupField.Strategy CHILDREN

Travels the direct children.

SIBLINGS

public static final LookupField.Strategy SIBLINGS

Travels the siblings.

TOP

public static final LookupField.Strategy TOP

Sets the annotated field to the top component of the component tree, which is the enclosing subsystem.

TREE

public static final LookupField.Strategy TREE

Travels the whole component tree.

BYNAME

@Deprecated
public static final LookupField.Strategy BYNAME

Deprecated. it should not be used.

Sets the annotated field to the component named after the field name.

Method Detail

values

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

Returns:

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

valueOf

public static LookupField.Strategy 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