Package io.thestencil.staticontent.spi.visitor

Class ImmutableSiteVisitorOutput.Builder

java.lang.Object

io.thestencil.staticontent.spi.visitor.ImmutableSiteVisitorOutput.Builder

Enclosing class:

ImmutableSiteVisitorOutput

@NotThreadSafe
public static final class ImmutableSiteVisitorOutput.Builder
extends Object

Builds instances of type ImmutableSiteVisitorOutput. 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
ImmutableSiteVisitorOutput.Builder	addAllMessage(Iterable<? extends SiteVisitor.Message> elements)	Adds elements to message list.
ImmutableSiteVisitorOutput.Builder	addAllSites(Iterable<? extends MigrationBuilder.LocalizedSite> elements)	Adds elements to sites list.
ImmutableSiteVisitorOutput.Builder	addMessage(SiteVisitor.Message element)	Adds one element to message list.
ImmutableSiteVisitorOutput.Builder	addMessage(SiteVisitor.Message... elements)	Adds elements to message list.
ImmutableSiteVisitorOutput.Builder	addSites(MigrationBuilder.LocalizedSite element)	Adds one element to sites list.
ImmutableSiteVisitorOutput.Builder	addSites(MigrationBuilder.LocalizedSite... elements)	Adds elements to sites list.
ImmutableSiteVisitorOutput	build()	Builds a new ImmutableSiteVisitorOutput.
ImmutableSiteVisitorOutput.Builder	from(SiteVisitor.SiteVisitorOutput instance)	Fill a builder with attribute values from the provided SiteVisitorOutput instance.
ImmutableSiteVisitorOutput.Builder	message(Iterable<? extends SiteVisitor.Message> elements)	Sets or replaces all elements for message list.
ImmutableSiteVisitorOutput.Builder	sites(Iterable<? extends MigrationBuilder.LocalizedSite> elements)	Sets or replaces all elements for sites list.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableSiteVisitorOutput.Builder from(SiteVisitor.SiteVisitorOutput instance)

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

addMessage

@CanIgnoreReturnValue
public final ImmutableSiteVisitorOutput.Builder addMessage(SiteVisitor.Message element)

Adds one element to message list.

Parameters:

element - A message element

Returns:

this builder for use in a chained invocation

addMessage

@CanIgnoreReturnValue
public final ImmutableSiteVisitorOutput.Builder addMessage(SiteVisitor.Message... elements)

Adds elements to message list.

Parameters:

elements - An array of message elements

Returns:

this builder for use in a chained invocation

message

@CanIgnoreReturnValue
public final ImmutableSiteVisitorOutput.Builder message(Iterable<? extends SiteVisitor.Message> elements)

Sets or replaces all elements for message list.

Parameters:

elements - An iterable of message elements

Returns:

this builder for use in a chained invocation

addAllMessage

@CanIgnoreReturnValue
public final ImmutableSiteVisitorOutput.Builder addAllMessage(Iterable<? extends SiteVisitor.Message> elements)

Adds elements to message list.

Parameters:

elements - An iterable of message elements

Returns:

this builder for use in a chained invocation

addSites

@CanIgnoreReturnValue
public final ImmutableSiteVisitorOutput.Builder addSites(MigrationBuilder.LocalizedSite element)

Adds one element to sites list.

Parameters:

element - A sites element

Returns:

this builder for use in a chained invocation

addSites

@CanIgnoreReturnValue
public final ImmutableSiteVisitorOutput.Builder addSites(MigrationBuilder.LocalizedSite... elements)

Adds elements to sites list.

Parameters:

elements - An array of sites elements

Returns:

this builder for use in a chained invocation

sites

@CanIgnoreReturnValue
public final ImmutableSiteVisitorOutput.Builder sites(Iterable<? extends MigrationBuilder.LocalizedSite> elements)

Sets or replaces all elements for sites list.

Parameters:

elements - An iterable of sites elements

Returns:

this builder for use in a chained invocation

addAllSites

@CanIgnoreReturnValue
public final ImmutableSiteVisitorOutput.Builder addAllSites(Iterable<? extends MigrationBuilder.LocalizedSite> elements)

Adds elements to sites list.

Parameters:

elements - An iterable of sites elements

Returns:

this builder for use in a chained invocation

build

public ImmutableSiteVisitorOutput build()

Builds a new ImmutableSiteVisitorOutput.

Returns:

An immutable instance of SiteVisitorOutput

Throws:

IllegalStateException - if any required attributes are missing