com.openinventor.inventor.actions

Enum SoSearchAction.Interests

java.lang.Object

java.lang.Enum<SoSearchAction.Interests>

com.openinventor.inventor.actions.SoSearchAction.Interests

All Implemented Interfaces:

IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoSearchAction.Interests>

Enclosing class:

SoSearchAction

public static enum SoSearchAction.Interests
extends java.lang.Enum<SoSearchAction.Interests>
implements IntegerValuedEnum

Enum that defines which paths to return.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Return all paths found.
FIRST Return only the first path found (default)
LAST Return only the last path found.

Method Summary

Modifier and Type	Method and Description
static SoSearchAction.Interests	fromValue(int val) Deprecated. Use valueOf(int) instead.
int	getValue() Returns the integer value of the enum constant.
static SoSearchAction.Interests	valueOf(int val) Returns the enum constant of this type with the specified integer value
static SoSearchAction.Interests	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SoSearchAction.Interests[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIRST

public static final SoSearchAction.Interests FIRST

Return only the first path found (default)

LAST

public static final SoSearchAction.Interests LAST

Return only the last path found.

ALL

public static final SoSearchAction.Interests ALL

Return all paths found.

Method Detail

values

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

Returns:

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

valueOf

public static SoSearchAction.Interests 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

fromValue

@Deprecated
public static SoSearchAction.Interests fromValue(int val)

Deprecated. Use valueOf(int) instead.

Returns the enum constant of this type with the specified integer value

Returns:

the enum constant of this type with the specified integer value.

valueOf

public static SoSearchAction.Interests valueOf(int val)

Returns the enum constant of this type with the specified integer value

Returns:

the enum constant of this type with the specified integer value.

getValue

public int getValue()

Description copied from interface: IntegerValuedEnum

Returns the integer value of the enum constant.

Specified by:

getValue in interface IntegerValuedEnum

Returns:

the integer value of the enum constant.