com.atlassian.bamboo.plan
Interface PlanParticleManager

All Known Implementing Classes:

PlanParticleManagerImpl

public interface PlanParticleManager

Method Summary

void	adjustPlanParticles(java.lang.String planKey, java.util.Collection<? extends PlanParticle> consumedParticles, java.util.Collection<? extends PlanParticle> producedParticles) Adjust list of plan's consumed and produced particles.
java.util.Set<java.lang.String>	getConsumersPlanKeys(java.util.Collection<? extends PlanParticle> planParticles) Return collection of Build's keys registered as planParticle consumers
java.util.Set<java.lang.String>	getProducersPlanKeys(java.util.Collection<? extends PlanParticle> planParticles) Return collection of Build's keys registered as planParticle producers
void	removePlanParticles(Plan plan) Removes all plan particles for a given plan.

Method Detail

getConsumersPlanKeys

@NotNull
java.util.Set<java.lang.String> getConsumersPlanKeys(java.util.Collection<? extends PlanParticle> planParticles)

Return collection of Build's keys registered as planParticle consumers

Parameters:

planParticles - collection of PlanParticles

Returns:

Collection of Build's keys registered as planParticle consumers

getProducersPlanKeys

@NotNull
java.util.Set<java.lang.String> getProducersPlanKeys(java.util.Collection<? extends PlanParticle> planParticles)

Return collection of Build's keys registered as planParticle producers

Parameters:

planParticles - collection of PlanParticles

Returns:

Collection of Build's keys registered as planParticle producers

adjustPlanParticles

void adjustPlanParticles(@NotNull
                         java.lang.String planKey,
                         @NotNull
                         java.util.Collection<? extends PlanParticle> consumedParticles,
                         @NotNull
                         java.util.Collection<? extends PlanParticle> producedParticles)
                         throws ConfigurationException

Adjust list of plan's consumed and produced particles.

Parameters:

planKey - Key of the plan to adjust.

consumedParticles - Collection of plan's consumed particles

producedParticles - Collection of plan's produced particles

Throws:

ConfigurationException - if it can not complete the adjusting of particles based on invalid data e.g cyclic dependencies

removePlanParticles

void removePlanParticles(@NotNull
                         Plan plan)

Removes all plan particles for a given plan. Needed when deleting the plan.

Parameters:

plan - to delete the particles of