Package com.io7m.smfj.processing.api

Class SMFFilterCommandModule.Builder

java.lang.Object

com.io7m.smfj.processing.api.SMFFilterCommandModule.Builder

Enclosing class:

SMFFilterCommandModule

public static final class SMFFilterCommandModule.Builder
extends java.lang.Object

Builds instances of type SMFFilterCommandModule. 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
SMFFilterCommandModule	build()	Builds a new SMFFilterCommandModule.
SMFFilterCommandModule.Builder	from(SMFFilterCommandModuleType instance)	Fill a builder with attribute values from the provided SMFFilterCommandModuleType instance.
SMFFilterCommandModule.Builder	putAllParsers(java.util.Map<java.lang.String,? extends SMFFilterCommandParserType> entries)	Put all mappings from the specified map as entries to parsers map.
SMFFilterCommandModule.Builder	putParsers(java.lang.String key, SMFFilterCommandParserType value)	Put one entry to the parsers map.
SMFFilterCommandModule.Builder	putParsers(java.util.Map.Entry<java.lang.String,? extends SMFFilterCommandParserType> entry)	Put one entry to the parsers map.
SMFFilterCommandModule.Builder	setName(java.lang.String name)	Initializes the value for the name attribute.
SMFFilterCommandModule.Builder	setParsers(java.util.Map<java.lang.String,? extends SMFFilterCommandParserType> entries)	Sets or replaces all mappings from the specified map as entries for the parsers map.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final SMFFilterCommandModule.Builder from(SMFFilterCommandModuleType instance)

Fill a builder with attribute values from the provided SMFFilterCommandModuleType 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

setName

public final SMFFilterCommandModule.Builder setName(java.lang.String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

putParsers

public final SMFFilterCommandModule.Builder putParsers(java.lang.String key,
                                                       SMFFilterCommandParserType value)

Put one entry to the parsers map.

Parameters:

key - The key in the parsers map

value - The associated value in the parsers map

Returns:

this builder for use in a chained invocation

putParsers

public final SMFFilterCommandModule.Builder putParsers(java.util.Map.Entry<java.lang.String,? extends SMFFilterCommandParserType> entry)

Put one entry to the parsers map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

setParsers

public final SMFFilterCommandModule.Builder setParsers(java.util.Map<java.lang.String,? extends SMFFilterCommandParserType> entries)

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

Parameters:

entries - The entries that will be added to the parsers map

Returns:

this builder for use in a chained invocation

putAllParsers

public final SMFFilterCommandModule.Builder putAllParsers(java.util.Map<java.lang.String,? extends SMFFilterCommandParserType> entries)

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

Parameters:

entries - The entries that will be added to the parsers map

Returns:

this builder for use in a chained invocation

build

public SMFFilterCommandModule build()

Builds a new SMFFilterCommandModule.

Returns:

An immutable instance of SMFFilterCommandModule

Throws:

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