Class ImmutableDescriptorFileProtocTarget.Builder

java.lang.Object

io.github.ascopes.protobufmavenplugin.protoc.targets.ImmutableDescriptorFileProtocTarget.Builder

Enclosing class:

ImmutableDescriptorFileProtocTarget

public static final class ImmutableDescriptorFileProtocTarget.Builder
extends Object

Builds instances of type ImmutableDescriptorFileProtocTarget. 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
ImmutableDescriptorFileProtocTarget	build()	Builds a new ImmutableDescriptorFileProtocTarget.
final ImmutableDescriptorFileProtocTarget.Builder	from(DescriptorFileProtocTarget instance)	Fill a builder with attribute values from the provided io.github.ascopes.protobufmavenplugin.protoc.targets.DescriptorFileProtocTarget instance.
final ImmutableDescriptorFileProtocTarget.Builder	from(ProtocTarget instance)	Fill a builder with attribute values from the provided io.github.ascopes.protobufmavenplugin.protoc.targets.ProtocTarget instance.
final ImmutableDescriptorFileProtocTarget.Builder	includeImports(boolean includeImports)	Initializes the value for the includeImports attribute.
final ImmutableDescriptorFileProtocTarget.Builder	includeSourceInfo(boolean includeSourceInfo)	Initializes the value for the includeSourceInfo attribute.
final ImmutableDescriptorFileProtocTarget.Builder	order(int order)	Initializes the value for the order attribute.
final ImmutableDescriptorFileProtocTarget.Builder	outputFile(Path outputFile)	Initializes the value for the outputFile attribute.
final ImmutableDescriptorFileProtocTarget.Builder	retainOptions(boolean retainOptions)	Initializes the value for the retainOptions attribute.

Methods inherited from class java.lang.Object

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

Method Details

from

public final ImmutableDescriptorFileProtocTarget.Builder from(ProtocTarget instance)

Fill a builder with attribute values from the provided io.github.ascopes.protobufmavenplugin.protoc.targets.ProtocTarget instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableDescriptorFileProtocTarget.Builder from(DescriptorFileProtocTarget instance)

Fill a builder with attribute values from the provided io.github.ascopes.protobufmavenplugin.protoc.targets.DescriptorFileProtocTarget instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

order

public final ImmutableDescriptorFileProtocTarget.Builder order(int order)

Initializes the value for the order attribute.

If not set, this attribute will have a default value as returned by the initializer of order.

Parameters:

order - The value for order

Returns:

this builder for use in a chained invocation

outputFile

public final ImmutableDescriptorFileProtocTarget.Builder outputFile(Path outputFile)

Initializes the value for the outputFile attribute.

Parameters:

outputFile - The value for outputFile (can be null)

Returns:

this builder for use in a chained invocation

includeImports

public final ImmutableDescriptorFileProtocTarget.Builder includeImports(boolean includeImports)

Initializes the value for the includeImports attribute.

Parameters:

includeImports - The value for includeImports

Returns:

this builder for use in a chained invocation

includeSourceInfo

public final ImmutableDescriptorFileProtocTarget.Builder includeSourceInfo(boolean includeSourceInfo)

Initializes the value for the includeSourceInfo attribute.

Parameters:

includeSourceInfo - The value for includeSourceInfo

Returns:

this builder for use in a chained invocation

retainOptions

public final ImmutableDescriptorFileProtocTarget.Builder retainOptions(boolean retainOptions)

Initializes the value for the retainOptions attribute.

Parameters:

retainOptions - The value for retainOptions

Returns:

this builder for use in a chained invocation

build

public ImmutableDescriptorFileProtocTarget build()

Builds a new ImmutableDescriptorFileProtocTarget.

Returns:

An immutable instance of DescriptorFileProtocTarget

Throws:

IllegalStateException - if any required attributes are missing