com.atlassian.bamboo.chains.cache

Interface ImmutableChainStage

All Superinterfaces:

BambooIdProvider, DescriptionProvider, ImmutableDeletable, ImmutableEntityWithOid, NameProvider

All Known Subinterfaces:

ChainStage

All Known Implementing Classes:

ChainStageImpl, ImmutableChainStageImpl

public interface ImmutableChainStage
extends DescriptionProvider, ImmutableDeletable, BambooIdProvider, ImmutableEntityWithOid

An immutable version of ChainStage. Prefer using this interface unless modifying the stage.

Method Summary

Modifier and Type	Method and Description
ImmutableChain	getChain() Gets the Chain that the stage belongs to
Optional<Long>	getDatabaseId()
String	getDescription() Get the Stage Description
default BambooEntityType	getEntityType() Entity type of this object, used in BambooEntityOid.
long	getId() Returns database id of the stage.
Set<? extends ImmutableJob>	getJobs() Gets the ImmutableJobs associated with this Stage.
ImmutableChainStage	getMaster()
String	getName() Get the Stage Name
boolean	hasMaster()
boolean	isFinal()
boolean	isManual()

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutableDeletable

isMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid

getOid

Method Detail

getId

long getId()

Returns database id of the stage. Use of getDatabaseId() should be preferred.

Specified by:

getId in interface BambooIdProvider

Throws:

IllegalStateException - if this stage is not a DB object.

getDatabaseId

@NotNull
Optional<Long> getDatabaseId()

Returns:

database id of the stage or empty if this stage is not a DB object.

getName

@NotNull
String getName()

Get the Stage Name

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

Returns:

name

getDescription

@Nullable
String getDescription()

Get the Stage Description

Specified by:

getDescription in interface DescriptionProvider

Returns:

description

isManual

boolean isManual()

isFinal

boolean isFinal()

getChain

@NotNull
ImmutableChain getChain()

Gets the Chain that the stage belongs to

Returns:

chain

getJobs

@NotNull
Set<? extends ImmutableJob> getJobs()

Gets the ImmutableJobs associated with this Stage. Only deletion code will see deleted jobs.

Returns:

jobs

getMaster

@Nullable
ImmutableChainStage getMaster()

hasMaster

boolean hasMaster()

getEntityType

default BambooEntityType getEntityType()

Description copied from interface: ImmutableEntityWithOid

Entity type of this object, used in BambooEntityOid.

Specified by:

getEntityType in interface ImmutableEntityWithOid