Package io.thestencil.staticontent.api

Class ImmutableHeading

java.lang.Object

io.thestencil.staticontent.api.ImmutableHeading

All Implemented Interfaces:

StaticContentClient.Heading

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableHeading
extends Object
implements StaticContentClient.Heading

Immutable implementation of StaticContentClient.Heading.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableHeading.Builder	builder()	Creates a builder for ImmutableHeading.
static ImmutableHeading	copyOf(StaticContentClient.Heading instance)	Creates an immutable copy of a StaticContentClient.Heading value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableHeading that have equal attribute values.
Integer	getLevel()
String	getName()
Integer	getOrder()
int	hashCode()	Computes a hash code from attributes: order, level, name.
String	toString()	Prints the immutable value Heading with attribute values.
ImmutableHeading	withLevel(Integer value)	Copy the current immutable object by setting a value for the level attribute.
ImmutableHeading	withName(String value)	Copy the current immutable object by setting a value for the name attribute.
ImmutableHeading	withOrder(Integer value)	Copy the current immutable object by setting a value for the order attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getOrder

public Integer getOrder()

Specified by:

getOrder in interface StaticContentClient.Heading

Returns:

The value of the order attribute

getLevel

public Integer getLevel()

Specified by:

getLevel in interface StaticContentClient.Heading

Returns:

The value of the level attribute

getName

public String getName()

Specified by:

getName in interface StaticContentClient.Heading

Returns:

The value of the name attribute

withOrder

public final ImmutableHeading withOrder(Integer value)

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

Parameters:

value - A new value for order

Returns:

A modified copy of the this object

withLevel

public final ImmutableHeading withLevel(Integer value)

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

Parameters:

value - A new value for level

Returns:

A modified copy of the this object

withName

public final ImmutableHeading withName(String value)

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

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableHeading 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: order, level, name.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Heading with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableHeading copyOf(StaticContentClient.Heading instance)

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

builder

public static ImmutableHeading.Builder builder()

Creates a builder for ImmutableHeading.

 ImmutableHeading.builder()
    .order(Integer) // required order
    .level(Integer) // required level
    .name(String) // required name
    .build();
 

Returns:

A new ImmutableHeading builder