Module com.zeroc.icegrid

Package com.zeroc.IceGrid

Enum Class LoadSample

java.lang.Object

java.lang.Enum<LoadSample>

com.zeroc.IceGrid.LoadSample

All Implemented Interfaces:

Serializable, Comparable<LoadSample>, Constable

public enum LoadSample
extends Enum<LoadSample>

Determines which load sampling interval to use.

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
LoadSample1	Sample every minute.
LoadSample15	Sample every fifteen minutes.
LoadSample5	Sample every five minutes.

Method Summary

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

LoadSample1

public static final LoadSample LoadSample1

Sample every minute.

LoadSample5

public static final LoadSample LoadSample5

Sample every five minutes.

LoadSample15

public static final LoadSample LoadSample15

Sample every fifteen minutes.

Method Details

values

public static LoadSample[] 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 LoadSample 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 LoadSample valueOf(int v)

Returns the LoadSample enumerator corresponding to the given integer value.

Parameters:

v - the value to match

Returns:

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

ice_write

public void ice_write(OutputStream ostr)

Marshals this LoadSample into an output stream.

Parameters:

ostr - the output stream

ice_write

public static void ice_write(OutputStream ostr,
 LoadSample v)

Marshals a LoadSample into an output stream.

Parameters:

ostr - the output stream

v - the LoadSample to marshal

ice_read

public static LoadSample ice_read(InputStream istr)

Unmarshals a LoadSample from an input stream.

Parameters:

istr - the input stream

Returns:

the unmarshaled LoadSample

ice_write

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

Marshals an optional LoadSample 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,
 LoadSample v)

Marshals an optional LoadSample into an output stream.

Parameters:

ostr - the output stream

tag - the tag

v - the value to marshal

ice_read

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

Unmarshals an optional LoadSample from an input stream.

Parameters:

istr - the input stream

tag - the tag

Returns:

the unmarshaled value