de.innovationgate.webgate.api

Class WGDatabaseRevision

java.lang.Object

de.innovationgate.webgate.api.WGDatabaseRevision

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WGDatabaseRevision>

public class WGDatabaseRevision
extends java.lang.Object
implements java.lang.Comparable<WGDatabaseRevision>, java.io.Serializable

Represents a database revision and provides methods to operate with it, including comparision, serialisation and derserialisation

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WGDatabaseRevision(java.lang.Number revisionNumber)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(WGDatabaseRevision otherRevision)
static WGDatabaseRevision	deserialize(java.lang.String serialized) Deserializes a serialized revision
boolean	equals(java.lang.Object obj)
static WGDatabaseRevision	forValue(java.lang.Comparable<?> o) Creates a database revision object from a raw revision value
java.lang.Comparable<?>	getRevisionValue() Returns the raw revision value
int	hashCode()
boolean	isLaterEqualRevisionValuePossible() Checks for non-unique revisions if it is possible that a later revision with equal revision value exists than the revision from which this value was read.
boolean	isProbablyNewerThan(WGDatabaseRevision cacheRevision) Returns if the current revision may be newer than the given revision.
boolean	isUniqueValue() Returns if this revision value is unique among all revisions of the database.
java.lang.String	serialize() Return a persisteable serialized form of this revision
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WGDatabaseRevision

public WGDatabaseRevision(java.lang.Number revisionNumber)

Method Detail

getRevisionValue

public java.lang.Comparable<?> getRevisionValue()

Returns the raw revision value

forValue

public static WGDatabaseRevision forValue(java.lang.Comparable<?> o)

Creates a database revision object from a raw revision value

Parameters:

o -

Returns:

The database revision object

Throws:

java.io.IOException

deserialize

public static WGDatabaseRevision deserialize(java.lang.String serialized)
                                      throws java.io.IOException

Deserializes a serialized revision

Parameters:

serialized - The serialized revision

Throws:

java.io.IOException

serialize

public java.lang.String serialize()
                           throws java.io.IOException

Return a persisteable serialized form of this revision

Throws:

java.io.IOException

compareTo

public int compareTo(WGDatabaseRevision otherRevision)

Specified by:

compareTo in interface java.lang.Comparable<WGDatabaseRevision>

isProbablyNewerThan

public boolean isProbablyNewerThan(WGDatabaseRevision cacheRevision)

Returns if the current revision may be newer than the given revision. This is only a probable value because with non-unique revisions (CS3) it is not determinable just by the revision values if one revision may be newer than the other. They may have the same value yet still originate from different revisions.

isUniqueValue

public boolean isUniqueValue()

Returns if this revision value is unique among all revisions of the database. False means that there may be multiple revisions with this revision value.

isLaterEqualRevisionValuePossible

public boolean isLaterEqualRevisionValuePossible()

Checks for non-unique revisions if it is possible that a later revision with equal revision value exists than the revision from which this value was read. To determine this the method uses the time when this revision value was read. If after this time it is impossible that another new revision uses the same revision value it returns false.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object