Module com.zeroc.ice

Package com.zeroc.Ice

Enum Class OperationMode

java.lang.Object

java.lang.Enum<OperationMode>

com.zeroc.Ice.OperationMode

All Implemented Interfaces:

Serializable, Comparable<OperationMode>, Constable

public enum OperationMode
extends Enum<OperationMode>

Specifies if an operation is idempotent, which affects the retry behavior of the Ice client runtime.

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
Idempotent	An idempotent operation.
Nonmutating	Equivalent to Idempotent, but deprecated.
Normal	A non-idempotent operation (the default).

Method Summary

Modifier and Type	Method	Description
static OperationMode	ice_read(InputStream istr)	Unmarshals an OperationMode from an input stream.
static Optional<OperationMode>	ice_read(InputStream istr, int tag)	Unmarshals an optional OperationMode from an input stream.
void	ice_write(OutputStream ostr)	Marshals this OperationMode into an output stream.
static void	ice_write(OutputStream ostr, int tag, OperationMode v)	Marshals an optional OperationMode into an output stream.
static void	ice_write(OutputStream ostr, int tag, Optional<OperationMode> v)	Marshals an optional OperationMode into an output stream.
static void	ice_write(OutputStream ostr, OperationMode v)	Marshals an OperationMode into an output stream.
int	value()	Returns the integer value of this enumerator.
static OperationMode	valueOf(int v)	Returns the OperationMode enumerator corresponding to the given integer value.
static OperationMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OperationMode[]	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

Normal

public static final OperationMode Normal

A non-idempotent operation (the default). The Ice client runtime guarantees that it will not violate at-most-once semantics for operations with this mode.

Nonmutating

public static final OperationMode Nonmutating

Equivalent to Idempotent, but deprecated.

Idempotent

public static final OperationMode Idempotent

An idempotent operation. The Ice client runtime does not guarantee at-most-once semantics for such an operation.

Remarks: When an operation is idempotent, the Ice runtime will attempt to transparently recover from certain runtime errors by re-issuing a failed request transparently.

Method Details

values

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

value

public int value()

Returns the integer value of this enumerator.

Returns:

the integer value of this enumerator

valueOf

public static OperationMode valueOf(int v)

Returns the OperationMode enumerator corresponding to the given integer value.

Parameters:

v - the value to match

Returns:

the OperationMode enumerator corresponding to the given integer value, or null if no such enumerator exists

ice_write

public void ice_write(OutputStream ostr)

Marshals this OperationMode into an output stream.

Parameters:

ostr - the output stream

ice_write

public static void ice_write(OutputStream ostr,
 OperationMode v)

Marshals an OperationMode into an output stream.

Parameters:

ostr - the output stream

v - the OperationMode to marshal

ice_read

public static OperationMode ice_read(InputStream istr)

Unmarshals an OperationMode from an input stream.

Parameters:

istr - the input stream

Returns:

the unmarshaled OperationMode

ice_write

public static void ice_write(OutputStream ostr,
 int tag,
 Optional<OperationMode> v)

Marshals an optional OperationMode into an output stream.

Parameters:

ostr - the output stream

tag - the tag

v - the value to marshal

ice_write

public static void ice_write(OutputStream ostr,
 int tag,
 OperationMode v)

Marshals an optional OperationMode into an output stream.

Parameters:

ostr - the output stream

tag - the tag

v - the value to marshal

ice_read

public static Optional<OperationMode> ice_read(InputStream istr,
 int tag)

Unmarshals an optional OperationMode from an input stream.

Parameters:

istr - the input stream

tag - the tag

Returns:

the unmarshaled value