io.protostuff.compiler.model

Class ImmutableModule.Builder

java.lang.Object

io.protostuff.compiler.model.ImmutableModule.Builder

Enclosing class:

ImmutableModule

@NotThreadSafe
public static final class ImmutableModule.Builder
extends Object

Builds instances of ImmutableModule. Initialize attributes and then invoke build() method to create immutable instance.

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

Method Summary

Modifier and Type	Method and Description
ImmutableModule.Builder	addAllProtos(Iterable<? extends Proto> elements) Adds elements to protos list.
ImmutableModule.Builder	addProtos(Proto... elements) Adds elements to protos list.
ImmutableModule.Builder	addProtos(Proto element) Adds one element to protos list.
ImmutableModule	build() Builds new ImmutableModule.
ImmutableModule.Builder	from(Module instance) Fill builder with attribute values from provided Module instance.
ImmutableModule.Builder	name(String name) Initializes value for name.
ImmutableModule.Builder	options(Map<String,? extends String> entries) Sets or replaces all mappings from specified map as entries for options map.
ImmutableModule.Builder	output(String output) Initializes value for output.
ImmutableModule.Builder	protos(Iterable<? extends Proto> elements) Sets or replaces all elements for protos list.
ImmutableModule.Builder	putAllOptions(Map<String,? extends String> entries) Put all mappings from specified map as entries to options map.
ImmutableModule.Builder	putOptions(Map.Entry<String,? extends String> entry) Put one entry to options map.
ImmutableModule.Builder	putOptions(String key, String value) Put one entry to options map.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableModule.Builder from(Module instance)

Fill builder with attribute values from provided Module instance. Regular attribute values will be replaced with ones of an instance. Instance's absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - instance to copy values from

Returns:

this builder for chained invocation

name

public final ImmutableModule.Builder name(String name)

Initializes value for name.

Parameters:

name - value for name

Returns:

this builder for chained invocation

addProtos

public final ImmutableModule.Builder addProtos(Proto element)

Adds one element to protos list.

Parameters:

element - protos element

Returns:

this builder for chained invocation

addProtos

public final ImmutableModule.Builder addProtos(Proto... elements)

Adds elements to protos list.

Parameters:

elements - array of protos elements

Returns:

this builder for chained invocation

protos

public final ImmutableModule.Builder protos(Iterable<? extends Proto> elements)

Sets or replaces all elements for protos list.

Parameters:

elements - iterable of protos elements

Returns:

this builder for chained invocation

addAllProtos

public final ImmutableModule.Builder addAllProtos(Iterable<? extends Proto> elements)

Adds elements to protos list.

Parameters:

elements - iterable of protos elements

Returns:

this builder for chained invocation

output

public final ImmutableModule.Builder output(String output)

Initializes value for output.

Parameters:

output - value for output

Returns:

this builder for chained invocation

putOptions

public final ImmutableModule.Builder putOptions(String key,
                                                String value)

Put one entry to options map.

Parameters:

key - the key in options map

value - the associated value in options map

Returns:

this builder for chained invocation

putOptions

public final ImmutableModule.Builder putOptions(Map.Entry<String,? extends String> entry)

Put one entry to options map. Nulls are not permitted

Parameters:

entry - the key and value entry

Returns:

this builder for chained invocation

options

public final ImmutableModule.Builder options(Map<String,? extends String> entries)

Sets or replaces all mappings from specified map as entries for options map. Nulls are not permitted

Parameters:

entries - to be added to options map

Returns:

this builder for chained invocation

putAllOptions

public final ImmutableModule.Builder putAllOptions(Map<String,? extends String> entries)

Put all mappings from specified map as entries to options map. Nulls are not permitted

Parameters:

entries - to be added to options map

Returns:

this builder for chained invocation

build

public ImmutableModule build()
                      throws IllegalStateException

Builds new ImmutableModule.

Returns:

immutable instance of Module

Throws:

exception - java.lang.IllegalStateException if any required attributes are missing

IllegalStateException