Package org.eclipse.scanning.api.event.core

Enum Class IRequester.ResponseType

java.lang.Object

java.lang.Enum<IRequester.ResponseType>

org.eclipse.scanning.api.event.core.IRequester.ResponseType

All Implemented Interfaces:

Serializable, Comparable<IRequester.ResponseType>, Constable

Enclosing interface:

IRequester<T extends IdBean>

public static enum IRequester.ResponseType
extends Enum<IRequester.ResponseType>

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
ONE	One response is required, after that comes in, return.
ONE_OR_MORE	Multiple responses are required, wait for the response timeout and collate all responses.

Method Summary

Modifier and Type	Method	Description
static IRequester.ResponseType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IRequester.ResponseType[]	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

ONE

public static final IRequester.ResponseType ONE

One response is required, after that comes in, return. If the timeout is reached throw an exception.

This is more efficient because the timeout is not waited for, it can return as soon as the first message is encountered.

ONE_OR_MORE

public static final IRequester.ResponseType ONE_OR_MORE

Multiple responses are required, wait for the response timeout and collate all responses. If no response comes in, throw an exception.

Less efficient but caters for multiple sources of the response if there may be some.

Method Details

values

public static IRequester.ResponseType[] 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 IRequester.ResponseType 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