com.atlassian.bamboo.plan
Interface PlanParticleManager

All Known Implementing Classes:
PlanParticleManagerImpl

public interface PlanParticleManager


Method Summary
 void adjustPlanParticles(PlanKey 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<PlanKey> getConsumersPlanKeys(java.lang.Iterable<? extends PlanParticle> planParticles)
          Return collection of Plan keys registered as planParticle consumers
 java.util.Set<PlanKey> getConsumersPlanKeys(PlanKey planKey)
          Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey
 java.util.Set<PlanKey> getProducersPlanKeys(java.lang.Iterable<? extends PlanParticle> planParticles)
          Return collection of Plan keys registered as planParticle producers
 java.util.Set<PlanKey> getProducersPlanKeys(PlanKey planKey)
          Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey
 void removePlanParticles(PlanKey planKey)
          Removes all plan particles for a given plan.
 

Method Detail

getConsumersPlanKeys

@NotNull
java.util.Set<PlanKey> getConsumersPlanKeys(java.lang.Iterable<? extends PlanParticle> planParticles)
Return collection of Plan keys registered as planParticle consumers

Parameters:
planParticles - collection of PlanParticles
Returns:
Collection of Plan keys registered as planParticle consumers

getConsumersPlanKeys

@NotNull
java.util.Set<PlanKey> getConsumersPlanKeys(@NotNull
                                                    PlanKey planKey)
Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey

Parameters:
planKey - identifies producer of particles
Returns:
Collection of Plan keys

getProducersPlanKeys

@NotNull
java.util.Set<PlanKey> getProducersPlanKeys(java.lang.Iterable<? extends PlanParticle> planParticles)
Return collection of Plan keys registered as planParticle producers

Parameters:
planParticles - collection of PlanParticles
Returns:
Collection of Plan keys registered as planParticle producers

getProducersPlanKeys

@NotNull
java.util.Set<PlanKey> getProducersPlanKeys(@NotNull
                                                    PlanKey planKey)
Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey

Parameters:
planKey - identifies producer of particles
Returns:
Collection of Plan keys

adjustPlanParticles

void adjustPlanParticles(@NotNull
                         PlanKey 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
                         PlanKey planKey)
Removes all plan particles for a given plan. Needed when deleting the plan.

Parameters:
planKey - to delete the particles of


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.