joynr.types

Enum DiscoveryScope

java.lang.Object

java.lang.Enum<DiscoveryScope>

joynr.types.DiscoveryScope

All Implemented Interfaces:

Serializable, Comparable<DiscoveryScope>

public enum DiscoveryScope
extends Enum<DiscoveryScope>

Enumeration specifying the discovery scope choices

Enum Constant Summary

Enum Constants

Enum Constant and Description
GLOBAL_ONLY Consider only globally registered providers.
LOCAL_AND_GLOBAL Consider both locally registered providers and globally ones.
LOCAL_ONLY Consider only locally registered providers.
LOCAL_THEN_GLOBAL Consider only locally registered providers, if no results are found, query global cache as well.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAJOR_VERSION
static int	MINOR_VERSION

Method Summary

Modifier and Type	Method and Description
static DiscoveryScope	getEnumValue(Integer ordinal) Get the matching enum for an ordinal number
Integer	getOrdinal() Get the matching ordinal number for this enum
static DiscoveryScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static DiscoveryScope[]	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

LOCAL_ONLY

public static final DiscoveryScope LOCAL_ONLY

Consider only locally registered providers.

LOCAL_THEN_GLOBAL

public static final DiscoveryScope LOCAL_THEN_GLOBAL

Consider only locally registered providers, if no results are found, query global cache as well. If no results are found in cache, query global capabilities directory.

LOCAL_AND_GLOBAL

public static final DiscoveryScope LOCAL_AND_GLOBAL

Consider both locally registered providers and globally ones. If no results are found in cache, query global capabilities directory.

GLOBAL_ONLY

public static final DiscoveryScope GLOBAL_ONLY

Consider only globally registered providers. If no results are found in cache, query global capabilities directory.

Field Detail

MAJOR_VERSION

public static final int MAJOR_VERSION

See Also:

Constant Field Values

MINOR_VERSION

public static final int MINOR_VERSION

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getEnumValue

public static DiscoveryScope getEnumValue(Integer ordinal)

Get the matching enum for an ordinal number

Parameters:

ordinal - The ordinal number

Returns:

The matching enum for the given ordinal number

getOrdinal

public Integer getOrdinal()

Get the matching ordinal number for this enum

Returns:

The ordinal number representing this enum