Class ImmutableGenerationRequest.Builder

java.lang.Object

io.github.ascopes.protobufmavenplugin.generation.ImmutableGenerationRequest.Builder

Enclosing class:

ImmutableGenerationRequest

public static final class ImmutableGenerationRequest.Builder
extends Object

Builds instances of type ImmutableGenerationRequest. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
final ImmutableGenerationRequest.Builder	addAllDependencyScopes(Iterable<String> elements)	Adds elements to dependencyScopes set.
final ImmutableGenerationRequest.Builder	addAllExcludes(Iterable<String> elements)	Adds elements to excludes list.
final ImmutableGenerationRequest.Builder	addAllIncludes(Iterable<String> elements)	Adds elements to includes list.
final ImmutableGenerationRequest.Builder	addDependencyScopes(String element)	Adds one element to dependencyScopes set.
final ImmutableGenerationRequest.Builder	addDependencyScopes(String... elements)	Adds elements to dependencyScopes set.
final ImmutableGenerationRequest.Builder	addExcludes(String element)	Adds one element to excludes list.
final ImmutableGenerationRequest.Builder	addExcludes(String... elements)	Adds elements to excludes list.
final ImmutableGenerationRequest.Builder	addIncludes(String element)	Adds one element to includes list.
final ImmutableGenerationRequest.Builder	addIncludes(String... elements)	Adds elements to includes list.
final ImmutableGenerationRequest.Builder	binaryMavenPlugins(Collection<? extends MavenProtocPlugin> binaryMavenPlugins)	Initializes the value for the binaryMavenPlugins attribute.
final ImmutableGenerationRequest.Builder	binaryPathPlugins(Collection<? extends PathProtocPlugin> binaryPathPlugins)	Initializes the value for the binaryPathPlugins attribute.
final ImmutableGenerationRequest.Builder	binaryUrlPlugins(Collection<? extends UrlProtocPlugin> binaryUrlPlugins)	Initializes the value for the binaryUrlPlugins attribute.
ImmutableGenerationRequest	build()	Builds a new ImmutableGenerationRequest.
final ImmutableGenerationRequest.Builder	dependencyResolutionDepth(DependencyResolutionDepth dependencyResolutionDepth)	Initializes the value for the dependencyResolutionDepth attribute.
final ImmutableGenerationRequest.Builder	dependencyScopes(Iterable<String> elements)	Sets or replaces all elements for dependencyScopes set.
final ImmutableGenerationRequest.Builder	enabledLanguages(Collection<Language> enabledLanguages)	Initializes the value for the enabledLanguages attribute.
final ImmutableGenerationRequest.Builder	excludes(Iterable<String> elements)	Sets or replaces all elements for excludes list.
final ImmutableGenerationRequest.Builder	from(GenerationRequest instance)	Fill a builder with attribute values from the provided GenerationRequest instance.
final ImmutableGenerationRequest.Builder	importDependencies(Collection<? extends MavenDependency> importDependencies)	Initializes the value for the importDependencies attribute.
final ImmutableGenerationRequest.Builder	importPaths(Collection<Path> importPaths)	Initializes the value for the importPaths attribute.
final ImmutableGenerationRequest.Builder	includes(Iterable<String> elements)	Sets or replaces all elements for includes list.
final ImmutableGenerationRequest.Builder	isEmbedSourcesInClassOutputs(boolean isEmbedSourcesInClassOutputs)	Initializes the value for the isEmbedSourcesInClassOutputs attribute.
final ImmutableGenerationRequest.Builder	isFailOnInvalidDependencies(boolean isFailOnInvalidDependencies)	Initializes the value for the isFailOnInvalidDependencies attribute.
final ImmutableGenerationRequest.Builder	isFailOnMissingSources(boolean isFailOnMissingSources)	Initializes the value for the isFailOnMissingSources attribute.
final ImmutableGenerationRequest.Builder	isFailOnMissingTargets(boolean isFailOnMissingTargets)	Initializes the value for the isFailOnMissingTargets attribute.
final ImmutableGenerationRequest.Builder	isFatalWarnings(boolean isFatalWarnings)	Initializes the value for the isFatalWarnings attribute.
final ImmutableGenerationRequest.Builder	isIgnoreProjectDependencies(boolean isIgnoreProjectDependencies)	Initializes the value for the isIgnoreProjectDependencies attribute.
final ImmutableGenerationRequest.Builder	isIncrementalCompilationEnabled(boolean isIncrementalCompilationEnabled)	Initializes the value for the isIncrementalCompilationEnabled attribute.
final ImmutableGenerationRequest.Builder	isLiteEnabled(boolean isLiteEnabled)	Initializes the value for the isLiteEnabled attribute.
final ImmutableGenerationRequest.Builder	isRegisterAsCompilationRoot(boolean isRegisterAsCompilationRoot)	Initializes the value for the isRegisterAsCompilationRoot attribute.
final ImmutableGenerationRequest.Builder	jvmMavenPlugins(Collection<? extends MavenProtocPlugin> jvmMavenPlugins)	Initializes the value for the jvmMavenPlugins attribute.
final ImmutableGenerationRequest.Builder	outputDirectory(Path outputDirectory)	Initializes the value for the outputDirectory attribute.
final ImmutableGenerationRequest.Builder	protocVersion(String protocVersion)	Initializes the value for the protocVersion attribute.
final ImmutableGenerationRequest.Builder	sourceDependencies(Collection<? extends MavenDependency> sourceDependencies)	Initializes the value for the sourceDependencies attribute.
final ImmutableGenerationRequest.Builder	sourceRootRegistrar(SourceRootRegistrar sourceRootRegistrar)	Initializes the value for the sourceRootRegistrar attribute.
final ImmutableGenerationRequest.Builder	sourceRoots(Collection<Path> sourceRoots)	Initializes the value for the sourceRoots attribute.

Methods inherited from class java.lang.Object

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

Method Details

from

public final ImmutableGenerationRequest.Builder from(GenerationRequest instance)

Fill a builder with attribute values from the provided GenerationRequest instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

binaryMavenPlugins

public final ImmutableGenerationRequest.Builder binaryMavenPlugins(Collection<? extends MavenProtocPlugin> binaryMavenPlugins)

Initializes the value for the binaryMavenPlugins attribute.

Parameters:

binaryMavenPlugins - The value for binaryMavenPlugins (can be null)

Returns:

this builder for use in a chained invocation

binaryPathPlugins

public final ImmutableGenerationRequest.Builder binaryPathPlugins(Collection<? extends PathProtocPlugin> binaryPathPlugins)

Initializes the value for the binaryPathPlugins attribute.

Parameters:

binaryPathPlugins - The value for binaryPathPlugins (can be null)

Returns:

this builder for use in a chained invocation

binaryUrlPlugins

public final ImmutableGenerationRequest.Builder binaryUrlPlugins(Collection<? extends UrlProtocPlugin> binaryUrlPlugins)

Initializes the value for the binaryUrlPlugins attribute.

Parameters:

binaryUrlPlugins - The value for binaryUrlPlugins (can be null)

Returns:

this builder for use in a chained invocation

dependencyResolutionDepth

public final ImmutableGenerationRequest.Builder dependencyResolutionDepth(DependencyResolutionDepth dependencyResolutionDepth)

Initializes the value for the dependencyResolutionDepth attribute.

Parameters:

dependencyResolutionDepth - The value for dependencyResolutionDepth (can be null)

Returns:

this builder for use in a chained invocation

addDependencyScopes

public final ImmutableGenerationRequest.Builder addDependencyScopes(String element)

Adds one element to dependencyScopes set.

Parameters:

element - A dependencyScopes element

Returns:

this builder for use in a chained invocation

addDependencyScopes

public final ImmutableGenerationRequest.Builder addDependencyScopes(String... elements)

Adds elements to dependencyScopes set.

Parameters:

elements - An array of dependencyScopes elements

Returns:

this builder for use in a chained invocation

dependencyScopes

public final ImmutableGenerationRequest.Builder dependencyScopes(Iterable<String> elements)

Sets or replaces all elements for dependencyScopes set.

Parameters:

elements - An iterable of dependencyScopes elements

Returns:

this builder for use in a chained invocation

addAllDependencyScopes

public final ImmutableGenerationRequest.Builder addAllDependencyScopes(Iterable<String> elements)

Adds elements to dependencyScopes set.

Parameters:

elements - An iterable of dependencyScopes elements

Returns:

this builder for use in a chained invocation

enabledLanguages

public final ImmutableGenerationRequest.Builder enabledLanguages(Collection<Language> enabledLanguages)

Initializes the value for the enabledLanguages attribute.

Parameters:

enabledLanguages - The value for enabledLanguages (can be null)

Returns:

this builder for use in a chained invocation

addExcludes

public final ImmutableGenerationRequest.Builder addExcludes(String element)

Adds one element to excludes list.

Parameters:

element - A excludes element

Returns:

this builder for use in a chained invocation

addExcludes

public final ImmutableGenerationRequest.Builder addExcludes(String... elements)

Adds elements to excludes list.

Parameters:

elements - An array of excludes elements

Returns:

this builder for use in a chained invocation

excludes

public final ImmutableGenerationRequest.Builder excludes(Iterable<String> elements)

Sets or replaces all elements for excludes list.

Parameters:

elements - An iterable of excludes elements

Returns:

this builder for use in a chained invocation

addAllExcludes

public final ImmutableGenerationRequest.Builder addAllExcludes(Iterable<String> elements)

Adds elements to excludes list.

Parameters:

elements - An iterable of excludes elements

Returns:

this builder for use in a chained invocation

importDependencies

public final ImmutableGenerationRequest.Builder importDependencies(Collection<? extends MavenDependency> importDependencies)

Initializes the value for the importDependencies attribute.

Parameters:

importDependencies - The value for importDependencies (can be null)

Returns:

this builder for use in a chained invocation

importPaths

public final ImmutableGenerationRequest.Builder importPaths(Collection<Path> importPaths)

Initializes the value for the importPaths attribute.

Parameters:

importPaths - The value for importPaths (can be null)

Returns:

this builder for use in a chained invocation

addIncludes

public final ImmutableGenerationRequest.Builder addIncludes(String element)

Adds one element to includes list.

Parameters:

element - A includes element

Returns:

this builder for use in a chained invocation

addIncludes

public final ImmutableGenerationRequest.Builder addIncludes(String... elements)

Adds elements to includes list.

Parameters:

elements - An array of includes elements

Returns:

this builder for use in a chained invocation

includes

public final ImmutableGenerationRequest.Builder includes(Iterable<String> elements)

Sets or replaces all elements for includes list.

Parameters:

elements - An iterable of includes elements

Returns:

this builder for use in a chained invocation

addAllIncludes

public final ImmutableGenerationRequest.Builder addAllIncludes(Iterable<String> elements)

Adds elements to includes list.

Parameters:

elements - An iterable of includes elements

Returns:

this builder for use in a chained invocation

jvmMavenPlugins

public final ImmutableGenerationRequest.Builder jvmMavenPlugins(Collection<? extends MavenProtocPlugin> jvmMavenPlugins)

Initializes the value for the jvmMavenPlugins attribute.

Parameters:

jvmMavenPlugins - The value for jvmMavenPlugins (can be null)

Returns:

this builder for use in a chained invocation

outputDirectory

public final ImmutableGenerationRequest.Builder outputDirectory(Path outputDirectory)

Initializes the value for the outputDirectory attribute.

Parameters:

outputDirectory - The value for outputDirectory (can be null)

Returns:

this builder for use in a chained invocation

protocVersion

public final ImmutableGenerationRequest.Builder protocVersion(String protocVersion)

Initializes the value for the protocVersion attribute.

Parameters:

protocVersion - The value for protocVersion (can be null)

Returns:

this builder for use in a chained invocation

sourceDependencies

public final ImmutableGenerationRequest.Builder sourceDependencies(Collection<? extends MavenDependency> sourceDependencies)

Initializes the value for the sourceDependencies attribute.

Parameters:

sourceDependencies - The value for sourceDependencies (can be null)

Returns:

this builder for use in a chained invocation

sourceRoots

public final ImmutableGenerationRequest.Builder sourceRoots(Collection<Path> sourceRoots)

Initializes the value for the sourceRoots attribute.

Parameters:

sourceRoots - The value for sourceRoots (can be null)

Returns:

this builder for use in a chained invocation

sourceRootRegistrar

public final ImmutableGenerationRequest.Builder sourceRootRegistrar(SourceRootRegistrar sourceRootRegistrar)

Initializes the value for the sourceRootRegistrar attribute.

Parameters:

sourceRootRegistrar - The value for sourceRootRegistrar (can be null)

Returns:

this builder for use in a chained invocation

isEmbedSourcesInClassOutputs

public final ImmutableGenerationRequest.Builder isEmbedSourcesInClassOutputs(boolean isEmbedSourcesInClassOutputs)

Initializes the value for the isEmbedSourcesInClassOutputs attribute.

Parameters:

isEmbedSourcesInClassOutputs - The value for isEmbedSourcesInClassOutputs

Returns:

this builder for use in a chained invocation

isFailOnInvalidDependencies

public final ImmutableGenerationRequest.Builder isFailOnInvalidDependencies(boolean isFailOnInvalidDependencies)

Initializes the value for the isFailOnInvalidDependencies attribute.

Parameters:

isFailOnInvalidDependencies - The value for isFailOnInvalidDependencies

Returns:

this builder for use in a chained invocation

isFailOnMissingSources

public final ImmutableGenerationRequest.Builder isFailOnMissingSources(boolean isFailOnMissingSources)

Initializes the value for the isFailOnMissingSources attribute.

Parameters:

isFailOnMissingSources - The value for isFailOnMissingSources

Returns:

this builder for use in a chained invocation

isFailOnMissingTargets

public final ImmutableGenerationRequest.Builder isFailOnMissingTargets(boolean isFailOnMissingTargets)

Initializes the value for the isFailOnMissingTargets attribute.

Parameters:

isFailOnMissingTargets - The value for isFailOnMissingTargets

Returns:

this builder for use in a chained invocation

isFatalWarnings

public final ImmutableGenerationRequest.Builder isFatalWarnings(boolean isFatalWarnings)

Initializes the value for the isFatalWarnings attribute.

Parameters:

isFatalWarnings - The value for isFatalWarnings

Returns:

this builder for use in a chained invocation

isIgnoreProjectDependencies

public final ImmutableGenerationRequest.Builder isIgnoreProjectDependencies(boolean isIgnoreProjectDependencies)

Initializes the value for the isIgnoreProjectDependencies attribute.

Parameters:

isIgnoreProjectDependencies - The value for isIgnoreProjectDependencies

Returns:

this builder for use in a chained invocation

isIncrementalCompilationEnabled

public final ImmutableGenerationRequest.Builder isIncrementalCompilationEnabled(boolean isIncrementalCompilationEnabled)

Initializes the value for the isIncrementalCompilationEnabled attribute.

Parameters:

isIncrementalCompilationEnabled - The value for isIncrementalCompilationEnabled

Returns:

this builder for use in a chained invocation

isLiteEnabled

public final ImmutableGenerationRequest.Builder isLiteEnabled(boolean isLiteEnabled)

Initializes the value for the isLiteEnabled attribute.

Parameters:

isLiteEnabled - The value for isLiteEnabled

Returns:

this builder for use in a chained invocation

isRegisterAsCompilationRoot

public final ImmutableGenerationRequest.Builder isRegisterAsCompilationRoot(boolean isRegisterAsCompilationRoot)

Initializes the value for the isRegisterAsCompilationRoot attribute.

Parameters:

isRegisterAsCompilationRoot - The value for isRegisterAsCompilationRoot

Returns:

this builder for use in a chained invocation

build

public ImmutableGenerationRequest build()

Builds a new ImmutableGenerationRequest.

Returns:

An immutable instance of GenerationRequest

Throws:

IllegalStateException - if any required attributes are missing