com.almworks.jira.structure.api.forest

Class VersionedForest

Object

VersionedForest

@PublicApi
 @Immutable
public final class VersionedForest
extends Object

VersionedForest represents a Forest, tagged with a DataVersion. It is used by ForestSource to provide versioned updates about forest content.

See Also:

ForestSource, VersionedForestUpdate

Field Summary

Fields

Modifier and Type	Field and Description
static VersionedForest	EMPTY

Constructor Summary

Constructors

Constructor and Description
VersionedForest(Forest forest, DataVersion version) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Forest	getForest() Returns the forest.
DataVersion	getVersion() Returns the version.
int	hashCode()
String	toString()

Methods inherited from class Object

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

Field Detail

EMPTY

public static final VersionedForest EMPTY

Constructor Detail

VersionedForest

public VersionedForest(@NotNull
                       Forest forest,
                       @NotNull
                       DataVersion version)

Constructs an instance.

Parameters:

forest - the forest, must be immutable!

version - version associated with the forest

Method Detail

getForest

@NotNull
public Forest getForest()

Returns the forest.

getVersion

@NotNull
public DataVersion getVersion()

Returns the version.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object