Package org.immutables.value.processor.meta

Class ImmutableAttributeBuilderDescriptor

java.lang.Object

org.immutables.value.processor.meta.AttributeBuilderDescriptor

org.immutables.value.processor.meta.ImmutableAttributeBuilderDescriptor

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class ImmutableAttributeBuilderDescriptor
extends AttributeBuilderDescriptor

Immutable implementation of AttributeBuilderDescriptor.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ImmutableAttributeBuilderDescriptor.Builder	Builds instances of type ImmutableAttributeBuilderDescriptor.
static interface	ImmutableAttributeBuilderDescriptor.BuildFinal
static interface	ImmutableAttributeBuilderDescriptor.BuildMethodBuildStage
static interface	ImmutableAttributeBuilderDescriptor.QualifiedBuilderConstructorMethodBuildStage
static interface	ImmutableAttributeBuilderDescriptor.QualifiedBuilderTypeNameBuildStage
static interface	ImmutableAttributeBuilderDescriptor.QualifiedValueTypeNameBuildStage
static interface	ImmutableAttributeBuilderDescriptor.ValueToBuilderMethodBuildStage
static interface	ImmutableAttributeBuilderDescriptor.ValueToBuilderTargetBuildStage

Nested classes/interfaces inherited from class org.immutables.value.processor.meta.AttributeBuilderDescriptor

AttributeBuilderDescriptor.ValueToBuilderTarget

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	buildMethod
private java.lang.String	qualifiedBuilderConstructorMethod
private java.lang.String	qualifiedBuilderTypeName
private java.lang.String	qualifiedValueTypeName
private java.lang.String	valueToBuilderMethod
private AttributeBuilderDescriptor.ValueToBuilderTarget	valueToBuilderTarget

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImmutableAttributeBuilderDescriptor(AttributeBuilderDescriptor.ValueToBuilderTarget valueToBuilderTarget, java.lang.String valueToBuilderMethod, java.lang.String buildMethod, java.lang.String qualifiedValueTypeName, java.lang.String qualifiedBuilderTypeName, java.lang.String qualifiedBuilderConstructorMethod)

Method Summary

Modifier and Type	Method	Description
static ImmutableAttributeBuilderDescriptor.ValueToBuilderTargetBuildStage	builder()	Creates a builder for ImmutableAttributeBuilderDescriptor.
static ImmutableAttributeBuilderDescriptor	copyOf(AttributeBuilderDescriptor instance)	Creates an immutable copy of a AttributeBuilderDescriptor value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of ImmutableAttributeBuilderDescriptor that have equal attribute values.
private boolean	equalTo(int synthetic, ImmutableAttributeBuilderDescriptor another)
java.lang.String	getBuildMethod()	A method to be invoked on the builder instance which returns a new value instance.
java.lang.String	getQualifiedBuilderConstructorMethod()	A fully qualified path and method which creates a new instance of a builder.
java.lang.String	getQualifiedBuilderTypeName()	A fully qualified type for the builder object.
java.lang.String	getQualifiedValueTypeName()	A fully qualified type for the value object.
protected java.lang.String	getValueToBuilderMethod()	A method name which when invoked will return a builder with all the properties set from the value object.
AttributeBuilderDescriptor.ValueToBuilderTarget	getValueToBuilderTarget()
int	hashCode()	Computes a hash code from attributes: valueToBuilderTarget, valueToBuilderMethod, buildMethod, qualifiedValueTypeName, qualifiedBuilderTypeName, qualifiedBuilderConstructorMethod.
java.lang.String	toString()	Prints the immutable value AttributeBuilderDescriptor with attribute values.
ImmutableAttributeBuilderDescriptor	withBuildMethod(java.lang.String value)	Copy the current immutable object by setting a value for the buildMethod attribute.
ImmutableAttributeBuilderDescriptor	withQualifiedBuilderConstructorMethod(java.lang.String value)	Copy the current immutable object by setting a value for the qualifiedBuilderConstructorMethod attribute.
ImmutableAttributeBuilderDescriptor	withQualifiedBuilderTypeName(java.lang.String value)	Copy the current immutable object by setting a value for the qualifiedBuilderTypeName attribute.
ImmutableAttributeBuilderDescriptor	withQualifiedValueTypeName(java.lang.String value)	Copy the current immutable object by setting a value for the qualifiedValueTypeName attribute.
ImmutableAttributeBuilderDescriptor	withValueToBuilderMethod(java.lang.String value)	Copy the current immutable object by setting a value for the valueToBuilderMethod attribute.
ImmutableAttributeBuilderDescriptor	withValueToBuilderTarget(AttributeBuilderDescriptor.ValueToBuilderTarget value)	Copy the current immutable object by setting a value for the valueToBuilderTarget attribute.

Methods inherited from class org.immutables.value.processor.meta.AttributeBuilderDescriptor

getQualifiedValueToBuilderMethod, getQualifiedValueTypeNameWithUnderscores, isCopyMethodOnValueInstance

Methods inherited from class java.lang.Object

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

Field Detail

valueToBuilderTarget

private final AttributeBuilderDescriptor.ValueToBuilderTarget valueToBuilderTarget

valueToBuilderMethod

private final java.lang.String valueToBuilderMethod

buildMethod

private final java.lang.String buildMethod

qualifiedValueTypeName

private final java.lang.String qualifiedValueTypeName

qualifiedBuilderTypeName

private final java.lang.String qualifiedBuilderTypeName

qualifiedBuilderConstructorMethod

private final java.lang.String qualifiedBuilderConstructorMethod

Constructor Detail

ImmutableAttributeBuilderDescriptor

private ImmutableAttributeBuilderDescriptor(AttributeBuilderDescriptor.ValueToBuilderTarget valueToBuilderTarget,
                                            java.lang.String valueToBuilderMethod,
                                            java.lang.String buildMethod,
                                            java.lang.String qualifiedValueTypeName,
                                            java.lang.String qualifiedBuilderTypeName,
                                            java.lang.String qualifiedBuilderConstructorMethod)

Method Detail

getValueToBuilderTarget

public AttributeBuilderDescriptor.ValueToBuilderTarget getValueToBuilderTarget()

Specified by:

getValueToBuilderTarget in class AttributeBuilderDescriptor

Returns:

The value of the valueToBuilderTarget attribute

getValueToBuilderMethod

protected java.lang.String getValueToBuilderMethod()

A method name which when invoked will return a builder with all the properties set from the value object. This method will be invoked based on getValueToBuilderTarget()

Specified by:

getValueToBuilderMethod in class AttributeBuilderDescriptor

Returns:

method to create a value instance. No () included.

getBuildMethod

public java.lang.String getBuildMethod()

A method to be invoked on the builder instance which returns a new value instance.

Specified by:

getBuildMethod in class AttributeBuilderDescriptor

Returns:

a method which constructs a new value instance.

getQualifiedValueTypeName

public java.lang.String getQualifiedValueTypeName()

A fully qualified type for the value object.

Specified by:

getQualifiedValueTypeName in class AttributeBuilderDescriptor

Returns:

fully qualified name of the value type.

getQualifiedBuilderTypeName

public java.lang.String getQualifiedBuilderTypeName()

A fully qualified type for the builder object.

Specified by:

getQualifiedBuilderTypeName in class AttributeBuilderDescriptor

Returns:

fully qualified name of the builder type.

getQualifiedBuilderConstructorMethod

public java.lang.String getQualifiedBuilderConstructorMethod()

A fully qualified path and method which creates a new instance of a builder. If the builder is constructed from a no-arg constructor, the new keyword should be prepended with a space.

Specified by:

getQualifiedBuilderConstructorMethod in class AttributeBuilderDescriptor

Returns:

static path which invoked will create a new empty builder. No () included.

withValueToBuilderTarget

public final ImmutableAttributeBuilderDescriptor withValueToBuilderTarget(AttributeBuilderDescriptor.ValueToBuilderTarget value)

Copy the current immutable object by setting a value for the valueToBuilderTarget attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for valueToBuilderTarget

Returns:

A modified copy of the this object

withValueToBuilderMethod

public final ImmutableAttributeBuilderDescriptor withValueToBuilderMethod(java.lang.String value)

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

Parameters:

value - A new value for valueToBuilderMethod

Returns:

A modified copy of the this object

withBuildMethod

public final ImmutableAttributeBuilderDescriptor withBuildMethod(java.lang.String value)

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

Parameters:

value - A new value for buildMethod

Returns:

A modified copy of the this object

withQualifiedValueTypeName

public final ImmutableAttributeBuilderDescriptor withQualifiedValueTypeName(java.lang.String value)

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

Parameters:

value - A new value for qualifiedValueTypeName

Returns:

A modified copy of the this object

withQualifiedBuilderTypeName

public final ImmutableAttributeBuilderDescriptor withQualifiedBuilderTypeName(java.lang.String value)

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

Parameters:

value - A new value for qualifiedBuilderTypeName

Returns:

A modified copy of the this object

withQualifiedBuilderConstructorMethod

public final ImmutableAttributeBuilderDescriptor withQualifiedBuilderConstructorMethod(java.lang.String value)

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

Parameters:

value - A new value for qualifiedBuilderConstructorMethod

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      java.lang.Object another)

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

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

equalTo

private boolean equalTo(int synthetic,
                        ImmutableAttributeBuilderDescriptor another)

hashCode

public int hashCode()

Computes a hash code from attributes: valueToBuilderTarget, valueToBuilderMethod, buildMethod, qualifiedValueTypeName, qualifiedBuilderTypeName, qualifiedBuilderConstructorMethod.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value AttributeBuilderDescriptor with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

copyOf

public static ImmutableAttributeBuilderDescriptor copyOf(AttributeBuilderDescriptor instance)

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

builder

public static ImmutableAttributeBuilderDescriptor.ValueToBuilderTargetBuildStage builder()

Creates a builder for ImmutableAttributeBuilderDescriptor.

 ImmutableAttributeBuilderDescriptor.builder()
    .valueToBuilderTarget(org.immutables.value.processor.meta.AttributeBuilderDescriptor.ValueToBuilderTarget) // required valueToBuilderTarget
    .valueToBuilderMethod(String) // required valueToBuilderMethod
    .buildMethod(String) // required buildMethod
    .qualifiedValueTypeName(String) // required qualifiedValueTypeName
    .qualifiedBuilderTypeName(String) // required qualifiedBuilderTypeName
    .qualifiedBuilderConstructorMethod(String) // required qualifiedBuilderConstructorMethod
    .build();
 

Returns:

A new ImmutableAttributeBuilderDescriptor builder