org.nuiton.db.meta

Class ImmutableProcedureMeta

java.lang.Object

org.nuiton.db.meta.ImmutableProcedureMeta

All Implemented Interfaces:

ProcedureMeta

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableProcedureMeta
extends Object
implements ProcedureMeta

Immutable implementation of ProcedureMeta.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableProcedureMeta.Builder	builder() Creates a builder for ImmutableProcedureMeta.
static ImmutableProcedureMeta	copyOf(ProcedureMeta instance) Creates an immutable copy of a ProcedureMeta value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableProcedureMeta that have equal attribute values.
com.google.common.collect.ImmutableList<ArgumentMeta>	getArgs()
Optional<String>	getComment()
String	getName()
int	hashCode() Computes a hash code from attributes: name, args, comment.
String	toString() Prints the immutable value ProcedureMeta with attribute values.
ImmutableProcedureMeta	withArgs(ArgumentMeta... elements) Copy the current immutable object with elements that replace the content of args.
ImmutableProcedureMeta	withArgs(Iterable<? extends ArgumentMeta> elements) Copy the current immutable object with elements that replace the content of args.
ImmutableProcedureMeta	withComment(Optional<String> optional) Copy the current immutable object by setting an optional value for the comment attribute.
ImmutableProcedureMeta	withComment(String value) Copy the current immutable object by setting a present value for the optional comment attribute.
ImmutableProcedureMeta	withName(String value) Copy the current immutable object by setting a value for the name attribute.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Specified by:

getName in interface ProcedureMeta

Returns:

The value of the name attribute

getArgs

public com.google.common.collect.ImmutableList<ArgumentMeta> getArgs()

Specified by:

getArgs in interface ProcedureMeta

Returns:

The value of the args attribute

getComment

public Optional<String> getComment()

Specified by:

getComment in interface ProcedureMeta

Returns:

The value of the comment attribute

withName

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

withArgs

public final ImmutableProcedureMeta withArgs(ArgumentMeta... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withArgs

public final ImmutableProcedureMeta withArgs(Iterable<? extends ArgumentMeta> elements)

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

Parameters:

elements - An iterable of args elements to set

Returns:

A modified copy of this object

withComment

public final ImmutableProcedureMeta withComment(String value)

Copy the current immutable object by setting a present value for the optional comment attribute.

Parameters:

value - The value for comment

Returns:

A modified copy of this object

withComment

public final ImmutableProcedureMeta withComment(Optional<String> optional)

Copy the current immutable object by setting an optional value for the comment attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.

Parameters:

optional - A value for comment

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableProcedureMeta 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: name, args, comment.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ProcedureMeta with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableProcedureMeta copyOf(ProcedureMeta instance)

Creates an immutable copy of a ProcedureMeta 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 ProcedureMeta instance

builder

public static ImmutableProcedureMeta.Builder builder()

Creates a builder for ImmutableProcedureMeta.

 ImmutableProcedureMeta.builder()
    .name(String) // required name
    .addArgs|addAllArgs(org.nuiton.db.meta.ArgumentMeta) // args elements
    .comment(String) // optional comment
    .build();
 

Returns:

A new ImmutableProcedureMeta builder