Enum Class Node.SwarmRole

java.lang.Object

java.lang.Enum<Node.SwarmRole>

com.github.cowwoc.docker.resource.Node.SwarmRole

All Implemented Interfaces:

Serializable, Comparable<Node.SwarmRole>, Constable

Enclosing class:

Node

public static enum Node.SwarmRole
extends Enum<Node.SwarmRole>

The role of the node within the swarm.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANAGER	A node that participates in administrating the swarm.
WORKER	A node that runs tasks.

Method Summary

Modifier and Type	Method	Description
String	toJson()	Returns the object's JSON representation.
static Node.SwarmRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Node.SwarmRole[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MANAGER

public static final Node.SwarmRole MANAGER

A node that participates in administrating the swarm.

WORKER

public static final Node.SwarmRole WORKER

A node that runs tasks.

Method Details

values

public static Node.SwarmRole[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Node.SwarmRole valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toJson

public String toJson()

Returns the object's JSON representation.

Returns:

the JSON representation