Package io.thestencil.client.spi.staticontent.visitors

Class ImmutableSiteVisitorOutput

java.lang.Object

io.thestencil.client.spi.staticontent.visitors.ImmutableSiteVisitorOutput

All Implemented Interfaces:

SiteVisitor.SiteVisitorOutput

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableSiteVisitorOutput
extends Object
implements SiteVisitor.SiteVisitorOutput

Immutable implementation of SiteVisitor.SiteVisitorOutput.

Use the builder to create immutable instances: ImmutableSiteVisitorOutput.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableSiteVisitorOutput.Builder	Builds instances of type ImmutableSiteVisitorOutput.

Method Summary

Modifier and Type	Method	Description
static ImmutableSiteVisitorOutput.Builder	builder()	Creates a builder for ImmutableSiteVisitorOutput.
static ImmutableSiteVisitorOutput	copyOf(SiteVisitor.SiteVisitorOutput instance)	Creates an immutable copy of a SiteVisitor.SiteVisitorOutput value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableSiteVisitorOutput that have equal attribute values.
com.google.common.collect.ImmutableList<SiteVisitor.Message>	getMessage()
com.google.common.collect.ImmutableList<MigrationBuilder.LocalizedSite>	getSites()
int	hashCode()	Computes a hash code from attributes: message, sites.
String	toString()	Prints the immutable value SiteVisitorOutput with attribute values.
ImmutableSiteVisitorOutput	withMessage(SiteVisitor.Message... elements)	Copy the current immutable object with elements that replace the content of message.
ImmutableSiteVisitorOutput	withMessage(Iterable<? extends SiteVisitor.Message> elements)	Copy the current immutable object with elements that replace the content of message.
ImmutableSiteVisitorOutput	withSites(MigrationBuilder.LocalizedSite... elements)	Copy the current immutable object with elements that replace the content of sites.
ImmutableSiteVisitorOutput	withSites(Iterable<? extends MigrationBuilder.LocalizedSite> elements)	Copy the current immutable object with elements that replace the content of sites.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getMessage

public com.google.common.collect.ImmutableList<SiteVisitor.Message> getMessage()

Specified by:

getMessage in interface SiteVisitor.SiteVisitorOutput

Returns:

The value of the message attribute

getSites

public com.google.common.collect.ImmutableList<MigrationBuilder.LocalizedSite> getSites()

Specified by:

getSites in interface SiteVisitor.SiteVisitorOutput

Returns:

The value of the sites attribute

withMessage

public final ImmutableSiteVisitorOutput withMessage(SiteVisitor.Message... elements)

Copy the current immutable object with elements that replace the content of message.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withMessage

public final ImmutableSiteVisitorOutput withMessage(Iterable<? extends SiteVisitor.Message> elements)

Copy the current immutable object with elements that replace the content of message. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of message elements to set

Returns:

A modified copy of this object

withSites

public final ImmutableSiteVisitorOutput withSites(MigrationBuilder.LocalizedSite... elements)

Copy the current immutable object with elements that replace the content of sites.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withSites

public final ImmutableSiteVisitorOutput withSites(Iterable<? extends MigrationBuilder.LocalizedSite> elements)

Copy the current immutable object with elements that replace the content of sites. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of sites elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableSiteVisitorOutput that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: message, sites.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SiteVisitorOutput with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableSiteVisitorOutput copyOf(SiteVisitor.SiteVisitorOutput instance)

Creates an immutable copy of a SiteVisitor.SiteVisitorOutput value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable SiteVisitorOutput instance

builder

public static ImmutableSiteVisitorOutput.Builder builder()

Creates a builder for ImmutableSiteVisitorOutput.

 ImmutableSiteVisitorOutput.builder()
    .addMessage|addAllMessage(io.thestencil.client.spi.staticontent.visitors.SiteVisitor.Message) // message elements
    .addSites|addAllSites(io.thestencil.client.api.MigrationBuilder.LocalizedSite) // sites elements
    .build();
 

Returns:

A new ImmutableSiteVisitorOutput builder