Package com.inductiveautomation.ignition.gateway.redundancy.types

Class VersionToken

java.lang.Object

com.inductiveautomation.ignition.gateway.redundancy.types.VersionToken

All Implemented Interfaces:

Serializable

public class VersionToken
extends Object
implements Serializable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
VersionToken(String newId, long revision)
VersionToken(String newId, long revision, Serializable versionDetails)

Method Summary

Modifier and Type	Method	Description
static VersionToken	cloneVersion(VersionToken theVersion)	Creates a new instance of a VersionToken object.
boolean	compatible(VersionToken other)
boolean	equals(Object obj)
long	getRevision()
String	getStateId()
Serializable	getVersionDetails()	This is data that can/will be used by sync providers to provide partial updates.
int	hashCode()
VersionToken	incrementRevision()	Mutates the current revision and returns this, for convenience.
static VersionToken	newToken()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

VersionToken

public VersionToken(String newId,
 long revision)

VersionToken

public VersionToken(String newId,
 long revision,
 Serializable versionDetails)

Method Details

newToken

public static VersionToken newToken()

incrementRevision

public VersionToken incrementRevision()

Mutates the current revision and returns this, for convenience.

getRevision

public long getRevision()

getStateId

public String getStateId()

getVersionDetails

public Serializable getVersionDetails()

This is data that can/will be used by sync providers to provide partial updates. Since it's in the VersionToken, it's passed along with such requests, and can be used to generate a diff.

compatible

public boolean compatible(VersionToken other)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

cloneVersion

@Nullable
public static VersionToken cloneVersion(VersionToken theVersion)

Creates a new instance of a VersionToken object. If the passed VersionToken was null, then a null object is also returned.