joynr.types

Enum ProviderScope

java.lang.Object

java.lang.Enum<ProviderScope>

joynr.types.ProviderScope

All Implemented Interfaces:

Serializable, Comparable<ProviderScope>

public enum ProviderScope
extends Enum<ProviderScope>

the scope in which the provider is registered

Enum Constant Summary

Enum Constants

Enum Constant and Description
GLOBAL indicates that the provider should be registered locally and globally.
LOCAL indicates that the provider is only for use with the local cluster controller.

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

GLOBAL

public static final ProviderScope GLOBAL

indicates that the provider should be registered locally and globally. An add will be performed in the global capabilities directory.

LOCAL

public static final ProviderScope LOCAL

indicates that the provider is only for use with the local cluster controller.

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

Returns:

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

valueOf

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