Package software.amazon.smithy.build

Class PluginContext.Builder

java.lang.Object

software.amazon.smithy.build.PluginContext.Builder

All Implemented Interfaces:

SmithyBuilder<PluginContext>

Enclosing class:

PluginContext

public static final class PluginContext.Builder
extends java.lang.Object
implements SmithyBuilder<PluginContext>

Builds a PluginContext.

Method Summary

Modifier and Type	Method	Description
PluginContext.Builder	artifactName(java.lang.String artifactName)	Set a custom artifact name used to change the output directory of a plugin.
PluginContext	build()	Creates an immutable object that is created from the properties that have been set on the builder.
PluginContext.Builder	events(java.util.List<ValidationEvent> events)	Sets the validation events that occurred after projecting the model.
PluginContext.Builder	fileManifest(FileManifest fileManifest)	Sets the required FileManifest to use in the plugin.
PluginContext.Builder	model(Model model)	Sets the required model that is being built.
PluginContext.Builder	originalModel(Model originalModel)	Sets the model that is being built before it was transformed in the projection.
PluginContext.Builder	pluginClassLoader(java.lang.ClassLoader pluginClassLoader)	Sets a ClassLoader that should be used by build plugins when loading services.
PluginContext.Builder	projection(java.lang.String name, ProjectionConfig projection)	Sets the projection that the plugin belongs to.
PluginContext.Builder	settings(ObjectNode settings)	Sets the settings of the plugin.
PluginContext.Builder	sources(java.util.Collection<java.nio.file.Path> sources)	Replaces the path to models that are considered "source" models of the package being built.

Methods inherited from class java.lang.Object

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

Method Detail

build

public PluginContext build()

Description copied from interface: SmithyBuilder

Creates an immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface SmithyBuilder<PluginContext>

Returns:

an instance of T

fileManifest

public PluginContext.Builder fileManifest(FileManifest fileManifest)

Sets the required FileManifest to use in the plugin.

Parameters:

fileManifest - FileManifest to use.

Returns:

Returns the builder.

model

public PluginContext.Builder model(Model model)

Sets the required model that is being built.

Parameters:

model - Model to set.

Returns:

Returns the builder.

projection

public PluginContext.Builder projection(java.lang.String name,
                                        ProjectionConfig projection)

Sets the projection that the plugin belongs to.

Parameters:

name - Name of the projection.

projection - ProjectionConfig to set.

Returns:

Returns the builder.

originalModel

public PluginContext.Builder originalModel(Model originalModel)

Sets the model that is being built before it was transformed in the projection.

Parameters:

originalModel - Original Model to set.

Returns:

Returns the builder.

events

public PluginContext.Builder events(java.util.List<ValidationEvent> events)

Sets the validation events that occurred after projecting the model.

Parameters:

events - Validation events to set.

Returns:

Returns the builder.

settings

public PluginContext.Builder settings(ObjectNode settings)

Sets the settings of the plugin.

Parameters:

settings - Settings to set.

Returns:

Returns the builder.

pluginClassLoader

public PluginContext.Builder pluginClassLoader(java.lang.ClassLoader pluginClassLoader)

Sets a ClassLoader that should be used by build plugins when loading services.

Parameters:

pluginClassLoader - ClassLoader to use in build plugins.

Returns:

Retruns the builder.

sources

public PluginContext.Builder sources(java.util.Collection<java.nio.file.Path> sources)

Replaces the path to models that are considered "source" models of the package being built.

Parameters:

sources - Source models to set.

Returns:

Returns the builder.

artifactName

public PluginContext.Builder artifactName(java.lang.String artifactName)

Set a custom artifact name used to change the output directory of a plugin.

An artifact name is useful when running plugins like "run" or when running a plugin multiple times in a single projection.

Parameters:

artifactName - Custom artifact name to set.

Returns:

Returns the builder.