Package kieker.common.namedRecordPipe

Enum Class Broker

java.lang.Object

java.lang.Enum<Broker>

kieker.common.namedRecordPipe.Broker

All Implemented Interfaces:

Serializable, Comparable<Broker>, Constable

public enum Broker
extends Enum<Broker>

Since:

1.3

Author:

Andre van Hoorn, Jan Waller

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
INSTANCE	This is the singleton instance.

Method Summary

Modifier and Type	Method	Description
Pipe	acquirePipe(String pipeName)	Returns a connection with name pipeName.
static Broker	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Broker[]	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

INSTANCE

public static final Broker INSTANCE

This is the singleton instance.

Method Details

values

public static Broker[] 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 Broker 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

acquirePipe

public Pipe acquirePipe(String pipeName)
                 throws IllegalArgumentException

Returns a connection with name pipeName. If a connection with this name does not exist prior to the call, it is created.

Parameters:

pipeName - The name of the pipe.

Returns:

The acquired pipe.

Throws:

IllegalArgumentException - If the pipe name is null or empty.