Package jetbrains.buildServer.serverSide.build.steps

Interface BuildStepsEditor

All Known Subinterfaces:

GroupStepContext

All Known Implementing Classes:

GroupStepContextImpl, StepsGroup

public interface BuildStepsEditor

For regular build configurations steps form a plain list. Meanwhile, it's allowed for plugins to alter this list to a tree with help of this editor interface and StepsFactory This interface represents edit API only for a selected level of steps tree.

Since:

8.0

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Method Summary

Modifier and Type	Method	Description
void	addRunner(SBuildStepDescriptor runnerToAdd)	Insterts a build runner to the sequence
void	addRunnerAfter(SBuildStepDescriptor runnerToAdd, SBuildStepDescriptor positionAncor)	Insterts a build runner to the sequence
void	addRunnerBefore(SBuildStepDescriptor runnerToAdd, SBuildStepDescriptor ancor)	Insterts a build runner to the sequence
Collection<? extends SBuildStepDescriptor>	getSteps()	Objects inside could probably implement GroupStepContext or RunnerStepContext Your implementation should be aware of possible new types of steps
void	removeRunner(SBuildStepDescriptor runnerToRemove)	Removes build runner from the build
void	replaceRunner(SBuildStepDescriptor runnerToRemove, SBuildStepDescriptor toInsert)	Removes build runner from the build

Method Detail

getSteps

@NotNull
Collection<? extends SBuildStepDescriptor> getSteps()

Objects inside could probably implement GroupStepContext or RunnerStepContext Your implementation should be aware of possible new types of steps

Returns:

collection of steps in the current tree level

Since:

8.0

removeRunner

void removeRunner(@NotNull
                  SBuildStepDescriptor runnerToRemove)

Removes build runner from the build

Parameters:

runnerContext - context to remove

runnerToRemove -

Since:

8.0

See Also:

#getRunnerContexts()

replaceRunner

void replaceRunner(@NotNull
                   SBuildStepDescriptor runnerToRemove,
                   @NotNull
                   SBuildStepDescriptor toInsert)

Removes build runner from the build

Parameters:

runnerContext - context to remove

runnerToRemove -

toInsert -

Since:

8.0

See Also:

#getRunnerContexts()

addRunnerAfter

void addRunnerAfter(@NotNull
                    SBuildStepDescriptor runnerToAdd,
                    @Nullable
                    SBuildStepDescriptor positionAncor)

Insterts a build runner to the sequence

Parameters:

runnerContext -

ancor - ancor after which to insert or null to instert before first

runnerToAdd -

positionAncor -

Since:

8.0

addRunnerBefore

void addRunnerBefore(@NotNull
                     SBuildStepDescriptor runnerToAdd,
                     @Nullable
                     SBuildStepDescriptor ancor)

Insterts a build runner to the sequence

Parameters:

runnerContext -

runnerToAdd -

ancor - ancor before which to insert or null to instert to the end

Since:

8.0

addRunner

void addRunner(@NotNull
               SBuildStepDescriptor runnerToAdd)

Insterts a build runner to the sequence

Parameters:

runnerContext -

ancor - ancor before which to insert or null to instert to the end

runnerToAdd -

Since:

8.0