com.almworks.jira.structure.api.forest
Class ForestUpdate

java.lang.Object
  com.almworks.jira.structure.api.forest.ForestUpdate

Direct Known Subclasses:

ForestUpdate.Empty, ForestUpdate.Full, ForestUpdate.Incremental

public abstract class ForestUpdate
extends Object

ForestUpdate represents information about what the client code needs to do to bring their version of some structure's forest to the some newer version.

There are three classes of the forest update, and there cannot be any others:

• ForestUpdate.Empty means that the client has up-to-date version of the forest.
• ForestUpdate.Incremental means that the client can bring their version of the forest up to date by applying a list of forest transformations.
• ForestUpdate.Full contains the full version of the forest.

The instances of this class are created in getForestUpdate method, generally there's no need to create instances yourself.

Author:

Igor Sereda

See Also:

StructureManager.getForestUpdate(java.lang.Long, java.lang.Long, java.lang.Long, com.atlassian.crowd.embedded.api.User, boolean)

Nested Class Summary

static class	ForestUpdate.Empty Empty update means that nothing needs to be done and the client code has the latest version of the forest.
static class	ForestUpdate.Full The full update contains the whole forest.
static class	ForestUpdate.Incremental Incremental update means that the client code should apply a series of transformations to bring their version of the forest to the latest version.

Constructor Summary

protected

ForestUpdate(long structureId, long version)

Method Summary

long	getStructureId()
long	getVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

ForestUpdate

protected ForestUpdate(long structureId,
                       long version)

Method Detail

getStructureId

public long getStructureId()

Returns:

the ID of the structure this update is about

getVersion

public long getVersion()

Returns:

the version of the structure's forest - after applying this update the client code will have this version of the forest