Package io.thestencil.client.api

Class ImmutableLink

java.lang.Object

io.thestencil.client.api.ImmutableLink

All Implemented Interfaces:

StencilClient.EntityBody, StencilClient.Link, Serializable

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableLink
extends Object
implements StencilClient.Link

Immutable implementation of StencilClient.Link.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableLink.Builder	builder()	Creates a builder for ImmutableLink.
static ImmutableLink	copyOf(StencilClient.Link instance)	Creates an immutable copy of a StencilClient.Link value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableLink that have equal attribute values.
com.google.common.collect.ImmutableList<String>	getArticles()
String	getContent()
String	getContentType()
String	getDescription()
String	getLocale()
int	hashCode()	Computes a hash code from attributes: articles, locale, content, contentType, description.
String	toString()	Prints the immutable value Link with attribute values.
ImmutableLink	withArticles(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of articles.
ImmutableLink	withArticles(String... elements)	Copy the current immutable object with elements that replace the content of articles.
ImmutableLink	withContent(String value)	Copy the current immutable object by setting a value for the content attribute.
ImmutableLink	withContentType(String value)	Copy the current immutable object by setting a value for the contentType attribute.
ImmutableLink	withDescription(String value)	Copy the current immutable object by setting a value for the description attribute.
ImmutableLink	withLocale(String value)	Copy the current immutable object by setting a value for the locale attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getArticles

public com.google.common.collect.ImmutableList<String> getArticles()

Specified by:

getArticles in interface StencilClient.Link

Returns:

The value of the articles attribute

getLocale

public String getLocale()

Specified by:

getLocale in interface StencilClient.Link

Returns:

The value of the locale attribute

getContent

public String getContent()

Specified by:

getContent in interface StencilClient.Link

Returns:

The value of the content attribute

getContentType

public String getContentType()

Specified by:

getContentType in interface StencilClient.Link

Returns:

The value of the contentType attribute

getDescription

public String getDescription()

Specified by:

getDescription in interface StencilClient.Link

Returns:

The value of the description attribute

withArticles

public final ImmutableLink withArticles(String... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withArticles

public final ImmutableLink withArticles(Iterable<String> elements)

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

Parameters:

elements - An iterable of articles elements to set

Returns:

A modified copy of this object

withLocale

public final ImmutableLink withLocale(String value)

Copy the current immutable object by setting a value for the locale attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for locale

Returns:

A modified copy of the this object

withContent

public final ImmutableLink withContent(String value)

Copy the current immutable object by setting a value for the content attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for content

Returns:

A modified copy of the this object

withContentType

public final ImmutableLink withContentType(String value)

Copy the current immutable object by setting a value for the contentType attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for contentType

Returns:

A modified copy of the this object

withDescription

public final ImmutableLink withDescription(String value)

Copy the current immutable object by setting a value for the description attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for description

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableLink 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: articles, locale, content, contentType, description.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Link with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableLink copyOf(StencilClient.Link instance)

Creates an immutable copy of a StencilClient.Link 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 Link instance

builder

public static ImmutableLink.Builder builder()

Creates a builder for ImmutableLink.

 ImmutableLink.builder()
    .addArticles|addAllArticles(String) // articles elements
    .locale(String) // required locale
    .content(String) // required content
    .contentType(String) // required contentType
    .description(String) // required description
    .build();
 

Returns:

A new ImmutableLink builder