Package com.caplin.datasource.publisher

Enum Class PublishFlag

java.lang.Object

java.lang.Enum<PublishFlag>

com.caplin.datasource.publisher.PublishFlag

All Implemented Interfaces:

Serializable, Comparable<PublishFlag>, java.lang.constant.Constable

public enum PublishFlag
extends Enum<PublishFlag>

Settable flags when publishing data using the TransformerPublisher. Default flags are STORE_IN_CACHE and PUBLISH_TO_PEERS.

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
MAINTAIN_TIMESTAMP	Maintain the feedtime for the update.
NO_FLAGS	Option to use if none of the flags should be set for an object or update.
NO_PERSISTENCE	Do not save the object to disk when the Transformer is shutdown.
PUBLISH_TO_PEERS	Publish the object/update to the DataSource peers.
SILENT_SEND	Do not send the object/update to other Transformer modules.
STORE_IN_CACHE	Store the object/update within the Transformer cache.

Method Summary

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

NO_FLAGS

public static final PublishFlag NO_FLAGS

Option to use if none of the flags should be set for an object or update.

STORE_IN_CACHE

public static final PublishFlag STORE_IN_CACHE

Store the object/update within the Transformer cache. This flag can be used for both objects and updates.

PUBLISH_TO_PEERS

public static final PublishFlag PUBLISH_TO_PEERS

Publish the object/update to the DataSource peers. This flag can be used for both objects and updates.

NO_PERSISTENCE

public static final PublishFlag NO_PERSISTENCE

Do not save the object to disk when the Transformer is shutdown. If the object is not being cached (i.e. the STORE_IN_CACHE flag is not set) then it cannot be saved to disk, even if this flag is omitted.

This flag will only be used by DataCache.put.

SILENT_SEND

public static final PublishFlag SILENT_SEND

Do not send the object/update to other Transformer modules. This flag can be used for both objects and updates.

MAINTAIN_TIMESTAMP

public static final PublishFlag MAINTAIN_TIMESTAMP

Maintain the feedtime for the update. The feedtime is the time that the last update was received by the Transformer core. If this flag is not set, then the feedtime will be changed to the time that the update is sent by the Transformer module to the core.

This flag will only be used by TransformerData.send.

Method Details

values

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

getFlagCode

public int getFlagCode()