Package io.thestencil.staticontent.spi.visitor

Class ImmutableTopicNameData.Builder

java.lang.Object

io.thestencil.staticontent.spi.visitor.ImmutableTopicNameData.Builder

Enclosing class:

ImmutableTopicNameData

@NotThreadSafe
public static final class ImmutableTopicNameData.Builder
extends Object

Builds instances of type ImmutableTopicNameData. 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
ImmutableTopicNameData	build()	Builds a new ImmutableTopicNameData.
ImmutableTopicNameData.Builder	from(SiteVisitor.TopicNameData instance)	Fill a builder with attribute values from the provided TopicNameData instance.
ImmutableTopicNameData.Builder	locale(Map<String,? extends String> entries)	Sets or replaces all mappings from the specified map as entries for the locale map.
ImmutableTopicNameData.Builder	path(String path)	Initializes the value for the path attribute.
ImmutableTopicNameData.Builder	putAllLocale(Map<String,? extends String> entries)	Put all mappings from the specified map as entries to locale map.
ImmutableTopicNameData.Builder	putLocale(String key, String value)	Put one entry to the locale map.
ImmutableTopicNameData.Builder	putLocale(Map.Entry<String,? extends String> entry)	Put one entry to the locale map.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableTopicNameData.Builder from(SiteVisitor.TopicNameData instance)

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

path

@CanIgnoreReturnValue
public final ImmutableTopicNameData.Builder path(String path)

Initializes the value for the path attribute.

Parameters:

path - The value for path

Returns:

this builder for use in a chained invocation

putLocale

@CanIgnoreReturnValue
public final ImmutableTopicNameData.Builder putLocale(String key,
                                                      String value)

Put one entry to the locale map.

Parameters:

key - The key in the locale map

value - The associated value in the locale map

Returns:

this builder for use in a chained invocation

putLocale

@CanIgnoreReturnValue
public final ImmutableTopicNameData.Builder putLocale(Map.Entry<String,? extends String> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

locale

@CanIgnoreReturnValue
public final ImmutableTopicNameData.Builder locale(Map<String,? extends String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllLocale

@CanIgnoreReturnValue
public final ImmutableTopicNameData.Builder putAllLocale(Map<String,? extends String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

build

public ImmutableTopicNameData build()

Builds a new ImmutableTopicNameData.

Returns:

An immutable instance of TopicNameData

Throws:

IllegalStateException - if any required attributes are missing