com.almworks.jira.structure.api.forest

Class VersionedForestUpdate

Object

VersionedDataUpdate

VersionedForestUpdate

Direct Known Subclasses:

VersionedForestUpdate.Full, VersionedForestUpdate.Incremental

@PublicApi
public abstract class VersionedForestUpdate
extends VersionedDataUpdate

Represents an update from ForestSource.

See Also:

ForestSource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VersionedForestUpdate.Full Represents a full update.
static class	VersionedForestUpdate.Incremental Represents an incremental update.

Method Summary

Modifier and Type	Method and Description
VersionedForestUpdate.Incremental	asIncremental() Casts this update to VersionedForestUpdate.Incremental type.
ForestSourceHealthStatus	getHealth()
VersionedForest	getLatest() Returns the full forest.

Methods inherited from class VersionedDataUpdate

getVersion, isEmpty, isFull, isIncremental

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLatest

@NotNull
public VersionedForest getLatest()

Returns the full forest. This method is provided for all updates (not only to full updates) because VersionedForest is immutable and the source can just share the link to the most recent forest it has.

asIncremental

@NotNull
public VersionedForestUpdate.Incremental asIncremental()

Casts this update to VersionedForestUpdate.Incremental type. You first need to make sure this is an incremental type.

Returns:

this

Throws:

ClassCastException - if the update is not incremental

getHealth

@NotNull
public ForestSourceHealthStatus getHealth()