io.quarkus.builder

Class BuildStepBuilder

java.lang.Object

io.quarkus.builder.BuildStepBuilder

public final class BuildStepBuilder
extends Object

A builder for build step instances within a chain. A build step can consume and produce items. It may also register a destructor for items it produces, which will be run (in indeterminate order) at the end of processing.

Constructor Summary

Constructors

Constructor and Description
BuildStepBuilder(BuildChainBuilder buildChainBuilder)

Method Summary

Modifier and Type	Method and Description
BuildStepBuilder	afterProduce(Class<? extends BuildItem> type) This build step should be initiated after any build steps which produce the given item type are completed.
<N> BuildStepBuilder	afterProduce(Class<? extends NamedBuildItem<N>> type, N name) This build step should be initiated after any build steps which produce the given item type are completed.
BuildStepBuilder	afterVirtual(Enum<?> symbolic) Declare that the build step "consumes" a virtual item with the given identifier.
BuildStepBuilder	afterVirtual(Enum<?> symbolic, ConsumeFlags flags) Declare that the build step "consumes" a virtual item with the given identifier.
BuildStepBuilder	beforeConsume(Class<? extends BuildItem> type) This build step should complete before any build steps which consume the given item type are initiated.
BuildStepBuilder	beforeConsume(Class<? extends BuildItem> type, ProduceFlag flag) This build step should complete before any build steps which consume the given item type are initiated.
<N> BuildStepBuilder	beforeConsume(Class<? extends NamedBuildItem<N>> type, N name) This build step should complete before any build steps which consume the given item type are initiated.
<N> BuildStepBuilder	beforeConsume(Class<? extends NamedBuildItem<N>> type, N name, ProduceFlag flag) This build step should complete before any build steps which consume the given item type are initiated.
BuildStepBuilder	beforeVirtual(Enum<?> symbolic) Declare that the build step "produces" a virtual item with the given identifier.
BuildStepBuilder	beforeVirtual(Enum<?> symbolic, ProduceFlag flag) Declare that the build step "produces" a virtual item with the given identifier.
BuildChainBuilder	build() Build this step into the chain.
BuildChainBuilder	buildIf(BooleanSupplier supp) Build this step into the chain if the supplier returns true.
BuildStepBuilder	consumes(Class<? extends BuildItem> type) This build step consumes the given produced item.
BuildStepBuilder	consumes(Class<? extends BuildItem> type, ConsumeFlags flags) This build step consumes the given produced item.
<N> BuildStepBuilder	consumes(Class<? extends NamedBuildItem<N>> type, N name) This build step consumes the given produced item.
<N> BuildStepBuilder	consumes(Class<? extends NamedBuildItem<N>> type, N name, ConsumeFlags flags) This build step consumes the given produced item.
(package private) BuildStep	getBuildStep()
(package private) Map<ItemId,Consume>	getConsumes()
(package private) Map<ItemId,Produce>	getProduces()
(package private) Set<ItemId>	getRealConsumes()
(package private) Set<ItemId>	getRealProduces()
BuildStepBuilder	produces(Class<? extends BuildItem> type) Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item.
BuildStepBuilder	produces(Class<? extends BuildItem> type, ProduceFlag flag) Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item.
BuildStepBuilder	produces(Class<? extends BuildItem> type, ProduceFlags flags) Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item.
<N> BuildStepBuilder	produces(Class<? extends NamedBuildItem<N>> type, N name) Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item.
<N> BuildStepBuilder	produces(Class<? extends NamedBuildItem<N>> type, N name, ProduceFlag flag) Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item.
BuildStepBuilder	setBuildStep(BuildStep buildStep) Set the build step for this builder.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BuildStepBuilder

BuildStepBuilder(BuildChainBuilder buildChainBuilder)

Method Detail

setBuildStep

public BuildStepBuilder setBuildStep(BuildStep buildStep)

Set the build step for this builder. If no build step is specified, then this step will be excluded from the final chain.

Parameters:

buildStep - the build step

Returns:

this builder

beforeConsume

public BuildStepBuilder beforeConsume(Class<? extends BuildItem> type)

This build step should complete before any build steps which consume the given item type are initiated. If no such build steps exist, no ordering constraint is enacted.

Parameters:

type - the item type (must not be null)

Returns:

this builder

beforeConsume

public BuildStepBuilder beforeConsume(Class<? extends BuildItem> type,
                                      ProduceFlag flag)

This build step should complete before any build steps which consume the given item type are initiated. If no such build steps exist, no ordering constraint is enacted.

Parameters:

type - the item type (must not be null)

flag - the producer flag to apply (must not be null)

Returns:

this builder

beforeConsume

public <N> BuildStepBuilder beforeConsume(Class<? extends NamedBuildItem<N>> type,
                                          N name)

This build step should complete before any build steps which consume the given item type are initiated. If no such build steps exist, no ordering constraint is enacted.

Parameters:

type - the item type (must not be null)

name - the build item name (must not be null)

Returns:

this builder

beforeConsume

public <N> BuildStepBuilder beforeConsume(Class<? extends NamedBuildItem<N>> type,
                                          N name,
                                          ProduceFlag flag)

This build step should complete before any build steps which consume the given item type are initiated. If no such build steps exist, no ordering constraint is enacted.

Parameters:

type - the item type (must not be null)

name - the build item name (must not be null)

flag - the producer flag to apply (must not be null)

Returns:

this builder

afterProduce

public BuildStepBuilder afterProduce(Class<? extends BuildItem> type)

This build step should be initiated after any build steps which produce the given item type are completed. If no such build steps exist, no ordering constraint is enacted.

Parameters:

type - the item type (must not be null)

Returns:

this builder

afterProduce

public <N> BuildStepBuilder afterProduce(Class<? extends NamedBuildItem<N>> type,
                                         N name)

This build step should be initiated after any build steps which produce the given item type are completed. If no such build steps exist, no ordering constraint is enacted.

Parameters:

type - the item type (must not be null)

name - the build item name (must not be null)

Returns:

this builder

produces

public BuildStepBuilder produces(Class<? extends BuildItem> type)

Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item. In addition, the build step may produce an actual value for this item, which will be shared to all consumers during deployment.

Parameters:

type - the item type (must not be null)

Returns:

this builder

produces

public BuildStepBuilder produces(Class<? extends BuildItem> type,
                                 ProduceFlag flag)

Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item. In addition, the build step may produce an actual value for this item, which will be shared to all consumers during deployment.

Parameters:

type - the item type (must not be null)

flag - the producer flag to apply (must not be null)

Returns:

this builder

produces

public BuildStepBuilder produces(Class<? extends BuildItem> type,
                                 ProduceFlags flags)

Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item. In addition, the build step may produce an actual value for this item, which will be shared to all consumers during deployment.

Parameters:

type - the item type (must not be null)

flags - the producer flag to apply (must not be null)

Returns:

this builder

produces

public <N> BuildStepBuilder produces(Class<? extends NamedBuildItem<N>> type,
                                     N name)

Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item. In addition, the build step may produce an actual value for this item, which will be shared to all consumers during deployment.

Parameters:

type - the item type (must not be null)

name - the build item name (must not be null)

Returns:

this builder

produces

public <N> BuildStepBuilder produces(Class<? extends NamedBuildItem<N>> type,
                                     N name,
                                     ProduceFlag flag)

Similarly to beforeConsume(Class), establish that this build step must come before the consumer(s) of the given item type; however, only one producer may exist for the given item. In addition, the build step may produce an actual value for this item, which will be shared to all consumers during deployment.

Parameters:

type - the item type (must not be null)

name - the build item name (must not be null)

flag - the producer flag to apply (must not be null)

Returns:

this builder

beforeVirtual

public BuildStepBuilder beforeVirtual(Enum<?> symbolic)

Declare that the build step "produces" a virtual item with the given identifier.

Parameters:

symbolic - the item identifier (must not be null)

Returns:

this builder

beforeVirtual

public BuildStepBuilder beforeVirtual(Enum<?> symbolic,
                                      ProduceFlag flag)

Declare that the build step "produces" a virtual item with the given identifier.

Parameters:

symbolic - the item identifier (must not be null)

flag - the producer flag to apply (must not be null)

Returns:

this builder

consumes

public BuildStepBuilder consumes(Class<? extends BuildItem> type)

This build step consumes the given produced item. The item must be produced somewhere in the chain. If no such producer exists, the chain will not be constructed; instead, an error will be raised.

Parameters:

type - the item type (must not be null)

Returns:

this builder

consumes

public <N> BuildStepBuilder consumes(Class<? extends NamedBuildItem<N>> type,
                                     N name)

This build step consumes the given produced item. The item must be produced somewhere in the chain. If no such producer exists, the chain will not be constructed; instead, an error will be raised.

Parameters:

type - the item type (must not be null)

name - the build item name (must not be null)

Returns:

this builder

consumes

public BuildStepBuilder consumes(Class<? extends BuildItem> type,
                                 ConsumeFlags flags)

This build step consumes the given produced item. The item must be produced somewhere in the chain. If no such producer exists, the chain will not be constructed; instead, an error will be raised.

Parameters:

type - the item type (must not be null)

flags - a set of flags which modify the consume operation (must not be null)

Returns:

this builder

consumes

public <N> BuildStepBuilder consumes(Class<? extends NamedBuildItem<N>> type,
                                     N name,
                                     ConsumeFlags flags)

This build step consumes the given produced item. The item must be produced somewhere in the chain. If no such producer exists, the chain will not be constructed; instead, an error will be raised.

Parameters:

type - the item type (must not be null)

flags - a set of flags which modify the consume operation (must not be null)

Returns:

this builder

afterVirtual

public BuildStepBuilder afterVirtual(Enum<?> symbolic)

Declare that the build step "consumes" a virtual item with the given identifier.

Parameters:

symbolic - the item identifier (must not be null)

Returns:

this builder

afterVirtual

public BuildStepBuilder afterVirtual(Enum<?> symbolic,
                                     ConsumeFlags flags)

Declare that the build step "consumes" a virtual item with the given identifier.

Parameters:

symbolic - the item identifier (must not be null)

flags - a set of flags which modify the consume operation (must not be null)

Returns:

this builder

build

public BuildChainBuilder build()

Build this step into the chain.

Returns:

the chain builder that this step was added to

buildIf

public BuildChainBuilder buildIf(BooleanSupplier supp)

Build this step into the chain if the supplier returns true.

Parameters:

supp - the boolean supplier (must not be null)

Returns:

the chain builder that this step was added to, or null if it was not added

getBuildStep

BuildStep getBuildStep()

getConsumes

Map<ItemId,Consume> getConsumes()

getProduces

Map<ItemId,Produce> getProduces()

getRealConsumes

Set<ItemId> getRealConsumes()

getRealProduces

Set<ItemId> getRealProduces()

toString

public String toString()

Overrides:

toString in class Object