com.atlassian.bamboo.plan.cache

Class PlansState

java.lang.Object

com.atlassian.bamboo.plan.cache.PlansState

@Immutable
 @ThreadSafe
public class PlansState
extends Object

An immutable class that represents the the available plans at a particular point in time.

Since:

v3.4

Constructor Summary

Constructors

Constructor and Description
PlansState()
PlansState(Iterable<? extends ImmutableChain> chainCache)

Method Summary

Modifier and Type	Method and Description
List<ImmutableChain>	getAllChains()
@NotNull List<ImmutableTopLevelPlan>	getAllTopLevelPlans()
ImmutableChain	getPlan(@NotNull PlanKey planKey)
com.google.common.collect.ImmutableCollection<ImmutableChain>	getUnsortedPlans()
PlansState	removePlanFromState(@NotNull PlanKey planKey) Removes the plan from the cache
PlansState	removePlansFromState(@NotNull Iterable<PlanKey> planKeys)
PlansState	updateState(@NotNull ImmutableChain plan)
PlansState	updateState(@NotNull Map<PlanKey,? extends ImmutableChain> plansMap)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlansState

public PlansState()

PlansState

public PlansState(Iterable<? extends ImmutableChain> chainCache)

Method Detail

getPlan

public ImmutableChain getPlan(@NotNull
                              @NotNull PlanKey planKey)

getAllTopLevelPlans

@NotNull
public @NotNull List<ImmutableTopLevelPlan> getAllTopLevelPlans()

getUnsortedPlans

public com.google.common.collect.ImmutableCollection<ImmutableChain> getUnsortedPlans()

getAllChains

public List<ImmutableChain> getAllChains()

updateState

public PlansState updateState(@NotNull
                              @NotNull ImmutableChain plan)

updateState

public PlansState updateState(@NotNull
                              @NotNull Map<PlanKey,? extends ImmutableChain> plansMap)

removePlanFromState

public PlansState removePlanFromState(@NotNull
                                      @NotNull PlanKey planKey)

Removes the plan from the cache

Parameters:

planKey - Key of the plan to be removed from cache

removePlansFromState

public PlansState removePlansFromState(@NotNull
                                       @NotNull Iterable<PlanKey> planKeys)