com.almworks.jira.structure.api.attribute

Class ConsistentRowValues

Object

ConsistentRowValues

@PublicApi
public class ConsistentRowValues
extends Object

ConsistentRowValues carries the values loaded in a consistent way, that is, when all the requested data retained their values during the loading process.

Note that these objects also contain the specific version of Forest that was used to calculate the values. This may be important when the consistent values are applied - it's better to use the forest retrieved here from getForest(), rather than request it separately, because it might change and the values contained in this class may not match the updated forest.

See Also:

StructureAttributeService.getConsistentAttributeValues(com.almworks.jira.structure.api.forest.ForestSpec, boolean, java.util.function.Function<com.almworks.jira.structure.api.forest.item.ItemForest, com.almworks.integers.LongList>, java.util.Collection<? extends com.almworks.jira.structure.api.attribute.AttributeSpec<?>>)

Field Summary

Fields

Modifier and Type	Field and Description
static ConsistentRowValues	EMPTY

Constructor Summary

Constructors

Constructor and Description
ConsistentRowValues(Forest forest, LongList requestedRows, Collection<? extends AttributeSpec<?>> requestedAttributes, RowValues values, DataVersion forestVersion, DataVersion itemsVersion)

Method Summary

Modifier and Type	Method and Description
Forest	getForest() Returns the forest that was used to calculate the consistent values.
DataVersion	getForestVersion() Returns the version of forest that was used to calculate the values.
DataVersion	getItemsVersion() Returns the version of the item update stream that was current when the values were loaded.
Collection<? extends AttributeSpec<?>>	getRequestedAttributes() Returns the attributes that were requested from StructureAttributeService.getConsistentAttributeValues(com.almworks.jira.structure.api.forest.ForestSpec, boolean, java.util.function.Function<com.almworks.jira.structure.api.forest.item.ItemForest, com.almworks.integers.LongList>, java.util.Collection<? extends com.almworks.jira.structure.api.attribute.AttributeSpec<?>>).
LongList	getRequestedRows() Returns the rows that were requested from StructureAttributeService.getConsistentAttributeValues(com.almworks.jira.structure.api.forest.ForestSpec, boolean, java.util.function.Function<com.almworks.jira.structure.api.forest.item.ItemForest, com.almworks.integers.LongList>, java.util.Collection<? extends com.almworks.jira.structure.api.attribute.AttributeSpec<?>>).
RowValues	getValues() Returns the values for the requested rows and attributes.

Methods inherited from class Object

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

Field Detail

EMPTY

public static final ConsistentRowValues EMPTY

Constructor Detail

ConsistentRowValues

public ConsistentRowValues(@NotNull
                           Forest forest,
                           @NotNull
                           LongList requestedRows,
                           @NotNull
                           Collection<? extends AttributeSpec<?>> requestedAttributes,
                           @NotNull
                           RowValues values,
                           @NotNull
                           DataVersion forestVersion,
                           @NotNull
                           DataVersion itemsVersion)

Method Detail

getValues

@NotNull
public RowValues getValues()

Returns the values for the requested rows and attributes.

Returns:

values

getForest

@NotNull
public Forest getForest()

Returns the forest that was used to calculate the consistent values.

Returns:

forest

getRequestedRows

@NotNull
public LongList getRequestedRows()

Returns the rows that were requested from StructureAttributeService.getConsistentAttributeValues(com.almworks.jira.structure.api.forest.ForestSpec, boolean, java.util.function.Function<com.almworks.jira.structure.api.forest.item.ItemForest, com.almworks.integers.LongList>, java.util.Collection<? extends com.almworks.jira.structure.api.attribute.AttributeSpec<?>>). Note that the included values may contain values for other rows, but they are not guaranteed to be consistent.

Returns:

requested rows

getRequestedAttributes

@NotNull
public Collection<? extends AttributeSpec<?>> getRequestedAttributes()

Returns the attributes that were requested from StructureAttributeService.getConsistentAttributeValues(com.almworks.jira.structure.api.forest.ForestSpec, boolean, java.util.function.Function<com.almworks.jira.structure.api.forest.item.ItemForest, com.almworks.integers.LongList>, java.util.Collection<? extends com.almworks.jira.structure.api.attribute.AttributeSpec<?>>). Note that the included values may contain values for other attributes, but they are not guaranteed to be consistent.

Returns:

requested attributes

getForestVersion

@NotNull
public DataVersion getForestVersion()

Returns the version of forest that was used to calculate the values.

Returns:

forest version

getItemsVersion

@NotNull
public DataVersion getItemsVersion()

Returns the version of the item update stream that was current when the values were loaded.

Returns:

item stream version

See Also:

ItemTracker