org.maestro.common

Enum Role

java.lang.Object

java.lang.Enum<Role>

org.maestro.common.Role

All Implemented Interfaces:

Serializable, Comparable<Role>

public enum Role
extends Enum<Role>

A numeric representation of the role as used by the Maestro protocol and Maestro data files

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGENT Agent
EXPORTER Exporter
INSPECTOR Inspector
OTHER Other role types
RECEIVER Receiver
SENDER Sender

Method Summary

Modifier and Type	Method and Description
static Role	from(int code) Builds a new Role type from an integer
int	getCode() Gets the role numeric code
static Role	hostTypeByName(String name) Builds a new Role type from a String (check HostTypes class for details)
boolean	isWorker()
String	toString()
static Role	valueOf(String name) Returns the enum constant of this type with the specified name.
static Role[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OTHER

public static final Role OTHER

Other role types

SENDER

public static final Role SENDER

Sender

RECEIVER

public static final Role RECEIVER

Receiver

INSPECTOR

public static final Role INSPECTOR

Inspector

AGENT

public static final Role AGENT

Agent

EXPORTER

public static final Role EXPORTER

Exporter

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public int getCode()

Gets the role numeric code

Returns:

the role numeric code

from

public static Role from(int code)

Builds a new Role type from an integer

Parameters:

code - the integer to build from

Returns:

A new Role object

toString

public String toString()

Overrides:

toString in class Enum<Role>

isWorker

public boolean isWorker()

hostTypeByName

public static Role hostTypeByName(String name)

Builds a new Role type from a String (check HostTypes class for details)

Parameters:

name - the string to build from

Returns:

A new Role object