com.almworks.jira.structure.api.forest.item

Class ImmutableItemForest

Object

ImmutableItemForest

All Implemented Interfaces:

ItemForest, RowRetriever

@PublicApi
 @Immutable
public final class ImmutableItemForest
extends Object
implements ItemForest

Field Summary

Fields

Modifier and Type	Field and Description
static ItemForest	EMPTY

Fields inherited from interface RowRetriever

IGNORE_MISSING_ROWS

Method Summary

Modifier and Type	Method and Description
static ImmutableItemForest	copy(ItemForest copyFrom)
static ImmutableItemForest	copySubtree(ItemForest copyFrom, long rootId)
Forest	getForest()
StructureRow	getRow(long rowId, ItemAccessMode access) Retrieves StructureRow with additional information about how the calling code is going to use method StructureRow.getItem(java.lang.Class<I>).
static ImmutableItemForest	of(Forest forest, Map<Long,StructureRow> rows)
static ImmutableItemForest	of(StructureRow row)
static ImmutableItemForest	rearrangeItemForest(ItemForest source, Forest newForest) Returns an ItemForest based on newForest, with rows taken from source.

Methods inherited from class Object

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

Methods inherited from interface ItemForest

collectItemIds

Methods inherited from interface RowRetriever

collectIssueIds, collectIssueIds, getRow, reduceOverRows, scanAllExistingRows, scanAllExistingRows, scanAllExistingRows, scanAllRows, scanAllRows, scanAllRows, scanAllRows, scanRows, scanRows, scanRows, scanRows

Field Detail

EMPTY

public static final ItemForest EMPTY

Method Detail

of

public static ImmutableItemForest of(@NotNull
                                     Forest forest,
                                     @NotNull
                                     Map<Long,StructureRow> rows)

of

public static ImmutableItemForest of(@NotNull
                                     StructureRow row)

copy

@NotNull
public static ImmutableItemForest copy(@NotNull
                                                ItemForest copyFrom)

copySubtree

@NotNull
public static ImmutableItemForest copySubtree(@NotNull
                                                       ItemForest copyFrom,
                                                       long rootId)

rearrangeItemForest

@NotNull
public static ImmutableItemForest rearrangeItemForest(@NotNull
                                                               ItemForest source,
                                                               @NotNull
                                                               Forest newForest)
                                                        throws MissingRowException

Returns an ItemForest based on newForest, with rows taken from source. newForest cannot contain any new rows, it must be a permutation or a sub-forest of source.getForest().

Throws:

MissingRowException - if some of the rows in the newForest are not found

getForest

@NotNull
public Forest getForest()

Specified by:

getForest in interface ItemForest

getRow

@NotNull
public StructureRow getRow(long rowId,
                                    @NotNull
                                    ItemAccessMode access)
                             throws MissingRowException

Description copied from interface: RowRetriever

Retrieves StructureRow with additional information about how the calling code is going to use method StructureRow.getItem(java.lang.Class<I>). The implementation may be optimized according to the access parameter.

If row's item is invisible or does not exist, StructureRow is returned anyway, but StructureRow.getItem(java.lang.Class<I>) return null.

Specified by:

getRow in interface RowRetriever

Parameters:

rowId - row ID

access - defines how item object is going to be accessed

Returns:

row instance

Throws:

MissingRowException - if the specified row ID does not exist

See Also:

ItemAccessMode