Package com.almworks.jira.structure.api.attribute

Interface ValuesMeta

@PublicApi public interface ValuesMeta

ValuesMeta contains additional information about an attribute loading process, executed by calling StructureAttributeService.loadAttributeValues(com.almworks.jira.structure.api.forest.ForestSpec, boolean, com.almworks.integers.LongList, java.util.Collection<? extends com.almworks.jira.structure.api.attribute.AttributeSpec<?>>, com.almworks.jira.structure.api.attribute.AttributeValuesReceiver). An instance of ValuesMeta is received via AttributeValuesReceiver.receiveMeta(ValuesMeta) method.

ValuesMeta may be used to extract diagnostic information about failed attributes. It can also be used to check if the there may be any updates to the values loaded.

See Also:

  • Method Details

    • getLoadingErrors

      @NotNull Collection<AttributeErrorInfo> getLoadingErrors()
      Returns the errors encountered during loading the values.
      Returns:
      a collection of loading errors

    • getItemsVersion

      @NotNull DataVersion getItemsVersion()
      Returns the version of the item change stream at a moment before all the values were loaded. Any subsequent item changes might cause some of the loaded values to be recalculated.
      Returns:
      data version of the item change stream
      See Also:

    • getForestVersion

      @NotNull DataVersion getForestVersion()
      Returns the version of the forest that was used to load the values. Returns DataVersion.ZERO if the forest was non-versioned (based on ItemForest).
      Returns:
      version of the forest
      See Also:

    • getItemCacheSequence

      @Internal @NotNull DataVersion getItemCacheSequence()
      Returns the version of the item-based value cache at which the values were loaded. This version reflects the sequence of invalidation events in the cache. This method is intended for internal use.
      Returns:
      version of the item-based value cache

    • getForestCacheSequence

      @Internal @NotNull DataVersion getForestCacheSequence()
      Returns the version of the forest-based value cache at which the values were loaded, or DataVersion.ZERO if the forest was not versioned. This version reflects the sequence of invalidation events in the cache. This method is intended for internal use.
      Returns:
      version of the forest-based value cache