com.almworks.jira.structure.api.attribute.loader

Interface ScanningAttributeContext

All Superinterfaces:

AttributeContext, AttributeLoaderContext, RowAttributeContext

@PublicApi
public interface ScanningAttributeContext
extends RowAttributeContext

The context interface for scanning attribute loaders.

See Also:

ScanningAttributeLoader

Method Summary

Modifier and Type	Method and Description
int	getDepth() Returns the depth of the row currently being loaded.
StructureRow	getPrecedingRow() Returns the row that immediately precedes this row in the forest.
int	getPrecedingRowDepth() Returns the depth of the row that immediately precedes this row in the forest.

Methods inherited from interface RowAttributeContext

getRow

Methods inherited from interface AttributeLoaderContext

addTrail, addTrail, getDependencyAttributeValue, getDependencyValue, valueExpires

Methods inherited from interface AttributeContext

getBaseStructureId, getBaseUrl, getI18n, getI18nHelper, getLoadTimeMillis, getLoadTimeNanos, getLocale, getObject, getTimeZone, getUser, putObject

Method Detail

getDepth

int getDepth()

Returns the depth of the row currently being loaded.

Root elements have depth of 0. Super-root is never loaded with a scanning loader.

Returns:

the depth of the row being loaded

getPrecedingRow

@Nullable
StructureRow getPrecedingRow()

Returns the row that immediately precedes this row in the forest. When calculating the very first row, returns null (and not the super-root!)

Returns:

preceding row

getPrecedingRowDepth

int getPrecedingRowDepth()

Returns the depth of the row that immediately precedes this row in the forest. When calculating the very first row, returns -1.

Root elements have depth of 0. Super-root is never loaded with a scanning loader.

Returns:

the depth of the preceding row