org.omg.dds.core.policy

Enum Durability.Kind

java.lang.Object

java.lang.Enum<Durability.Kind>

org.omg.dds.core.policy.Durability.Kind

All Implemented Interfaces:

Serializable, Comparable<Durability.Kind>

Enclosing interface:

Durability

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
PERSISTENT Data is kept on permanent storage, so that they can outlive a system session.
TRANSIENT The Service will attempt to keep some samples so that they can be delivered to any potential late-joining DataReader.
TRANSIENT_LOCAL The Service will attempt to keep some samples so that they can be delivered to any potential late-joining DataReader.
VOLATILE The Service does not need to keep any samples of data instances on behalf of any DataReader that is not known by the DataWriter at the time the instance is written.

Method Summary

Methods

Modifier and Type	Method and Description
static Durability.Kind	valueOf(String name) Returns the enum constant of this type with the specified name.
static Durability.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

VOLATILE

public static final Durability.Kind VOLATILE

The Service does not need to keep any samples of data instances on behalf of any DataReader that is not known by the DataWriter at the time the instance is written. In other words the Service will only attempt to provide the data to existing subscribers. This is the default kind.

TRANSIENT_LOCAL

public static final Durability.Kind TRANSIENT_LOCAL

The Service will attempt to keep some samples so that they can be delivered to any potential late-joining DataReader. Which particular samples are kept depends on other QoS such as History and ResourceLimits. For TRANSIENT_LOCAL, the service is only required to keep the data in the memory of the DataWriter that wrote the data and the data is not required to survive the DataWriter.

TRANSIENT

public static final Durability.Kind TRANSIENT

The Service will attempt to keep some samples so that they can be delivered to any potential late-joining DataReader. Which particular samples are kept depends on other QoS such as History and ResourceLimits. For TRANSIENT, the service is only required to keep the data in memory and not in permanent storage; but the data is not tied to the life cycle of the DataWriter and will, in general, survive it. Support for TRANSIENT kind is optional.

PERSISTENT

public static final Durability.Kind PERSISTENT

Data is kept on permanent storage, so that they can outlive a system session. Support for PERSISTENT kind is optional.

Method Detail

values

public static Durability.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 (Durability.Kind c : Durability.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 Durability.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