org.omg.dds.core.policy

Enum History.Kind

java.lang.Object

java.lang.Enum<History.Kind>

org.omg.dds.core.policy.History.Kind

All Implemented Interfaces:

Serializable, Comparable<History.Kind>

Enclosing interface:

History

public static enum History.Kind
extends Enum<History.Kind>

Enum Constant Summary

Enum Constants

Enum Constant and Description
KEEP_ALL On the publishing side, the Service will attempt to keep all samples (representing each value written) of each instance of data (identified by its key) managed by the DataWriter until they can be delivered to all subscribers.
KEEP_LAST On the publishing side, the Service will only attempt to keep the most recent "depth" samples (History.getDepth()) of each instance of data (identified by its key) managed by the DataWriter.

Method Summary

Methods

Modifier and Type	Method and Description
static History.Kind	valueOf(String name) Returns the enum constant of this type with the specified name.
static History.Kind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

KEEP_LAST

public static final History.Kind KEEP_LAST

On the publishing side, the Service will only attempt to keep the most recent "depth" samples (History.getDepth()) of each instance of data (identified by its key) managed by the DataWriter. On the subscribing side, the DataReader will only attempt to keep the most recent "depth" samples received for each instance (identified by its key) until the application "takes" them via DataReader.take(). KEEP_LAST is the default kind. The default value of depth is 1. If a value other than 1 is specified, it must be consistent with the settings of the ResourceLimits.

KEEP_ALL

public static final History.Kind KEEP_ALL

On the publishing side, the Service will attempt to keep all samples (representing each value written) of each instance of data (identified by its key) managed by the DataWriter until they can be delivered to all subscribers. On the subscribing side, the Service will attempt to keep all samples of each instance of data (identified by its key) managed by the DataReader. These samples are kept until the application "takes" them from the Service via DataReader.take(). The setting of depth has no effect. Its implied value is ResourceLimits.LENGTH_UNLIMITED.

Method Detail

values

public static History.Kind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (History.Kind c : History.Kind.values())
    System.out.println(c);

Returns:

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

valueOf

public static History.Kind valueOf(String name)

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

NullPointerException - if the argument is null