Package com.atlassian.bamboo.plan
Interface PlanParticleManager
-
- All Known Implementing Classes:
PlanParticleManagerImpl
@Internal public interface PlanParticleManager
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
adjustPlanParticles(@NotNull PlanKey planKey, @NotNull Collection<? extends PlanParticle> consumedParticles, @NotNull Collection<? extends PlanParticle> producedParticles)
Adjust list of plan's consumed and produced particles.@NotNull Set<PlanKey>
getConsumersPlanKeys(@NotNull PlanKey planKey)
Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey@NotNull Set<PlanKey>
getConsumersPlanKeys(Iterable<? extends PlanParticle> planParticles)
Return collection of Plan keys registered as planParticle consumers@NotNull Set<PlanKey>
getProducersPlanKeys(@NotNull PlanKey planKey)
Return collection of Plan keys registered as consumers of particles produced by plan identified with planKey@NotNull Set<PlanKey>
getProducersPlanKeys(Iterable<? extends PlanParticle> planParticles)
Return collection of Plan keys registered as planParticle producersvoid
removePlanParticles(@NotNull PlanKey planKey)
Removes all plan particles for a given plan.
-
-
-
Method Detail
-
getConsumersPlanKeys
@NotNull @NotNull Set<PlanKey> getConsumersPlanKeys(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 @NotNull Set<PlanKey> getConsumersPlanKeys(@NotNull @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 @NotNull Set<PlanKey> getProducersPlanKeys(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 @NotNull Set<PlanKey> getProducersPlanKeys(@NotNull @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 @NotNull PlanKey planKey, @NotNull @NotNull Collection<? extends PlanParticle> consumedParticles, @NotNull @NotNull 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 particlesproducedParticles
- 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 @NotNull PlanKey planKey)
Removes all plan particles for a given plan. Needed when deleting the plan.- Parameters:
planKey
- to delete the particles of
-
-