org.rvpf.base.value

Class VersionedValue

Object

PointValue

VersionedValue

All Implemented Interfaces:

Externalizable, Serializable, Mappable, Streamer.Validated

Direct Known Subclasses:

ReplicatedValue, VersionedValue.Deleted, VersionedValue.Purged

@NotThreadSafe
public class VersionedValue
extends PointValue

Versioned value.

This class extends PointValue by adding a version for the value: the time stamp in DateTime format of the last modification time (including creation). This is the representation used by TheStore to allow "pull" requests.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VersionedValue.Deleted Deleted.
static class	VersionedValue.Factory Factory.
static class	VersionedValue.Purged Purged.

Nested classes/interfaces inherited from class PointValue

PointValue.Null

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION_FIELD Version field key.

Fields inherited from class PointValue

NULL, POINT_FIELD, STAMP_FIELD, STATE_FIELD, UUID_FIELD, VALUE_FIELD

Fields inherited from interface Mappable

SERIALIZABLE_MODE, SIMPLE_STRING_MODE

Constructor Summary

Constructors

Modifier	Constructor and Description
	VersionedValue() Constructs an instance.
	VersionedValue(PointValue pointValue) Constructs an instance from a point value.
protected	VersionedValue(String point, Optional<DateTime> stamp) Constructs an instance.
protected	VersionedValue(UUID uuid, Optional<DateTime> stamp) Constructs an instance.
	VersionedValue(UUID uuid, Optional<DateTime> stamp, DateTime version, Serializable state, Serializable value) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
VersionedValue	copy() Creates a copy of this point value.
boolean	equals(Object other)
VersionedValue	frozen() Returns a frozen instance of this.
protected String	getStampString(DateTime.Context dateTimeContext) Gets the time stamp string.
DateTime	getVersion() Gets this value's version.
int	hashCode()
static DateTime	newVersion() Returns a new version stamp.
void	readExternal(ObjectInput input) Reads in an external representation of this.
void	readMap(Map<String,Serializable> map) Reads a map of the fields.
protected void	setVersion(DateTime version) Sets this value's version.
VersionedValue	thawed() Returns a thawed instance of this.
void	writeExternal(ObjectOutput output) Writes out an external representation of this.
void	writeMap(Map<String,Serializable> map) Writes a map of the fields.

Methods inherited from class PointValue

checkNotFrozen, clearStamp, confirm, copyValueFrom, decoded, denormalized, encoded, freeze, getNullablePoint, getPoint, getPointName, getPointUUID, getStamp, getState, getSynthesizedString, getThisLogger, getValue, hasPointUUID, hasStamp, isAbsent, isCacheable, isDeleted, isExtrapolated, isFrozen, isInterpolated, isNormalized, isPresent, isSynthesized, morph, morph, normalized, pointString, reset, restore, restore, sameValueAs, setFrozen, setPointName, setPointUUID, setStamp, setState, setValue, toDouble, toLong, toString, toString, updateStore, validate, valueString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VERSION_FIELD

public static final String VERSION_FIELD

Version field key.

See Also:

Constant Field Values

Constructor Detail

VersionedValue

public VersionedValue()

Constructs an instance.

This is needed for an externalizable implementation.

VersionedValue

public VersionedValue(PointValue pointValue)

Constructs an instance from a point value.

Parameters:

pointValue - The original point value.

VersionedValue

public VersionedValue(@Nonnull
                      UUID uuid,
                      @Nonnull
                      Optional<DateTime> stamp,
                      @Nonnull
                      DateTime version,
                      @Nullable
                      Serializable state,
                      @Nullable
                      Serializable value)

Constructs an instance.

Parameters:

uuid - The UUID of the Point definition.

stamp - The optional time stamp of the value.

version - The version of the value.

state - The state.

value - The value.

VersionedValue

protected VersionedValue(@Nonnull
                         String point,
                         @Nonnull
                         Optional<DateTime> stamp)

Constructs an instance.

Parameters:

point - A string identifying the point.

stamp - The optional time stamp of the value.

VersionedValue

protected VersionedValue(@Nonnull
                         UUID uuid,
                         @Nonnull
                         Optional<DateTime> stamp)

Constructs an instance.

Parameters:

uuid - The UUID of the Point definition.

stamp - The optional time stamp of the value.

Method Detail

newVersion

@Nonnull
 @CheckReturnValue
public static DateTime newVersion()

Returns a new version stamp.

Returns:

The new version stamp.

copy

public VersionedValue copy()

Creates a copy of this point value.

Overrides:

copy in class PointValue

Returns:

The copy.

equals

public boolean equals(Object other)

Overrides:

equals in class PointValue

frozen

public VersionedValue frozen()

Returns a frozen instance of this.

Overrides:

frozen in class PointValue

Returns:

This if frozen, or a frozen clone.

getVersion

public DateTime getVersion()

Gets this value's version.

Overrides:

getVersion in class PointValue

Returns:

The version (null when not available).

hashCode

public int hashCode()

Overrides:

hashCode in class PointValue

readExternal

public void readExternal(ObjectInput input)
                  throws IOException

Reads in an external representation of this.

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class PointValue

Parameters:

input - The external representation.

Throws:

IOException - When an I/O error occurs.

readMap

public void readMap(Map<String,Serializable> map)

Reads a map of the fields.

Specified by:

readMap in interface Mappable

Overrides:

readMap in class PointValue

Parameters:

map - The source map.

thawed

public VersionedValue thawed()

Returns a thawed instance of this.

Overrides:

thawed in class PointValue

Returns:

A clone if frozen, or this.

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes out an external representation of this.

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class PointValue

Parameters:

output - The external representation.

Throws:

IOException - When an I/O error occurs.

writeMap

public void writeMap(Map<String,Serializable> map)

Writes a map of the fields.

Specified by:

writeMap in interface Mappable

Overrides:

writeMap in class PointValue

Parameters:

map - The destination map.

getStampString

protected String getStampString(DateTime.Context dateTimeContext)

Gets the time stamp string.

Overrides:

getStampString in class PointValue

Parameters:

dateTimeContext - The date-time context.

Returns:

The time stamp string.

setVersion

protected void setVersion(DateTime version)

Sets this value's version.

Overrides:

setVersion in class PointValue

Parameters:

version - The version.