Package io.thestencil.persistence.api

Class ImmutableCreateLink

java.lang.Object

io.thestencil.persistence.api.ImmutableCreateLink

All Implemented Interfaces:

CreateBuilder.CreateLink

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableCreateLink
extends Object
implements CreateBuilder.CreateLink

Immutable implementation of CreateBuilder.CreateLink.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public String getValue()

Specified by:

getValue in interface CreateBuilder.CreateLink

Returns:

The value of the value attribute

getLocale

public String getLocale()

Specified by:

getLocale in interface CreateBuilder.CreateLink

Returns:

The value of the locale attribute

getDescription

public String getDescription()

Specified by:

getDescription in interface CreateBuilder.CreateLink

Returns:

The value of the description attribute

getType

public String getType()

Specified by:

getType in interface CreateBuilder.CreateLink

Returns:

The value of the type attribute

getArticles

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

Specified by:

getArticles in interface CreateBuilder.CreateLink

Returns:

The value of the articles attribute

withValue

public final ImmutableCreateLink withValue(String value)

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

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

withLocale

public final ImmutableCreateLink 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

withDescription

public final ImmutableCreateLink 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

withType

public final ImmutableCreateLink withType(String value)

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

Parameters:

value - A new value for type

Returns:

A modified copy of the this object

withArticles

public final ImmutableCreateLink 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 ImmutableCreateLink 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

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableCreateLink 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: value, locale, description, type, articles.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CreateLink with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableCreateLink copyOf(CreateBuilder.CreateLink instance)

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

builder

public static ImmutableCreateLink.Builder builder()

Creates a builder for ImmutableCreateLink.

 ImmutableCreateLink.builder()
    .value(String) // required value
    .locale(String) // required locale
    .description(String) // required description
    .type(String) // required type
    .addArticles|addAllArticles(String) // articles elements
    .build();
 

Returns:

A new ImmutableCreateLink builder