Package org.immutables.value.processor.meta

Class Constitution

java.lang.Object

org.immutables.value.processor.meta.Constitution

Direct Known Subclasses:

ImmutableConstitution

@Enclosing
@Immutable
public abstract class Constitution
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Constitution.AbstractNameForms
static class	Constitution.AppliedNameForms
class	Constitution.InnerBaseClassDefinition
final class	Constitution.InnerBuilderDefinition
final class	Constitution.InnerModifiableDefinition
static class	Constitution.NameForms

Field Summary

Fields

Modifier and Type	Field	Description
private static final com.google.common.base.Joiner	DOT_JOINER
private static final String	NA_ERROR
private static final String	NEW_KEYWORD

Constructor Summary

Constructors

Constructor	Description
Constitution()

Method Summary

Modifier and Type	Method	Description
private Constitution.AppliedNameForms	applyFactoryNaming(Naming naming)
Visibility	builderVisibility()
String	definingPackage()
Constitution.AppliedNameForms	factoryBuilder()
Constitution.AppliedNameForms	factoryCopyOf()
Constitution.AppliedNameForms	factoryCreate()
private Constitution.AppliedNameForms	factoryImplementationBuilder()
Constitution.AppliedNameForms	factoryInstance()
Constitution.AppliedNameForms	factoryOf()
Generics	generics()
boolean	hasEnclosingNonvalue()
boolean	hasImmutableInBuilder()
boolean	hasTopLevelBuilder()
boolean	hasTopLevelImmutable()
private Visibility	implementationEnclosingVisibility()
String	implementationPackage()
Visibility	implementationVisibility()
Constitution.InnerBuilderDefinition	innerBuilder()
Constitution.InnerModifiableDefinition	innerModifiable()
private String	inPackage(String topLevel, String... nested)	Package relative path
private boolean	isAbstractPrimary()
private boolean	isConstantNamingEquals(Naming naming, String name)
boolean	isFactory()
boolean	isImplementationHidden()
boolean	isImplementationPrimary()
boolean	isNested()
boolean	isNestedFactoryOrConstructor()
boolean	isOutsideBuilder()
boolean	isOutsideBuilderNotNested()
boolean	isSimple()
private boolean	isTopLevelValue()
Styles.UsingName.TypeNames	names()
abstract Proto.Protoclass	protoclass()
boolean	returnsAbstractValueType()
StyleInfo	style()
Constitution.NameForms	typeAbstract()	Actual abstract value type that is definitive model for the value type.
Constitution.NameForms	typeBuilder()
private String	typeBuilderSimpleName()
Constitution.NameForms	typeDocument()
Constitution.NameForms	typeEnclosing()
Constitution.NameForms	typeEnclosingFactory()
Constitution.NameForms	typeImmutable()	Actual immutable value type generated implementation.
(package private) String	typeImmutableEnclosingSimpleName()	Walks to the enclosing type's simple names and applies naming convention.
Constitution.NameForms	typeImplementationBuilder()
Constitution.NameForms	typeModifiable()
Constitution.NameForms	typePreferablyAbstract()
Constitution.NameForms	typeValue()	Value is the canonical outside look of the value type.
Constitution.NameForms	typeWith()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NA_ERROR

private static final String NA_ERROR

See Also:

• Constant Field Values

NEW_KEYWORD

private static final String NEW_KEYWORD

See Also:

• Constant Field Values

DOT_JOINER

private static final com.google.common.base.Joiner DOT_JOINER

Constructor Details

Constitution

public Constitution()

Method Details

protoclass

public abstract Proto.Protoclass protoclass()

generics

@Lazy
public Generics generics()

implementationVisibility

@Derived
public Visibility implementationVisibility()

builderVisibility

@Derived
public Visibility builderVisibility()

isImplementationHidden

public boolean isImplementationHidden()

returnsAbstractValueType

public boolean returnsAbstractValueType()

isImplementationPrimary

public boolean isImplementationPrimary()

implementationPackage

@Derived
public String implementationPackage()

definingPackage

public String definingPackage()

names

@Derived
public Styles.UsingName.TypeNames names()

typePreferablyAbstract

@Lazy
public Constitution.NameForms typePreferablyAbstract()

typeDocument

@Lazy
public Constitution.NameForms typeDocument()

typeModifiable

@Lazy
public Constitution.NameForms typeModifiable()

factoryCreate

@Lazy
public Constitution.AppliedNameForms factoryCreate()

isAbstractPrimary

private boolean isAbstractPrimary()

isSimple

public boolean isSimple()

typeValue

@Lazy
public Constitution.NameForms typeValue()

Value is the canonical outside look of the value type. It should be either typeAbstract() or typeImmutable(). For factory it is a special surrogate.

Returns:

canonical value type name forms

hasImmutableInBuilder

@Derived
public boolean hasImmutableInBuilder()

hasTopLevelBuilder

public boolean hasTopLevelBuilder()

isFactory

public boolean isFactory()

isNestedFactoryOrConstructor

public boolean isNestedFactoryOrConstructor()

isNested

public boolean isNested()

hasTopLevelImmutable

public boolean hasTopLevelImmutable()

isOutsideBuilder

public boolean isOutsideBuilder()

isTopLevelValue

private boolean isTopLevelValue()

hasEnclosingNonvalue

public boolean hasEnclosingNonvalue()

typeAbstract

@Lazy
public Constitution.NameForms typeAbstract()

Actual abstract value type that is definitive model for the value type.

Returns:

abstract value type name forms

style

public StyleInfo style()

inPackage

private String inPackage(String topLevel,
 String... nested)

Package relative path

typeImmutable

@Lazy
public Constitution.NameForms typeImmutable()

Actual immutable value type generated implementation.

Returns:

immutable implementation type name forms

typeImmutableEnclosingSimpleName

@Lazy
String typeImmutableEnclosingSimpleName()

Walks to the enclosing type's simple names and applies naming convention. This shortcut/fix shows deficiency of model (it's probably more complicated than needed).

Returns:

enclosing immutable name

typeBuilderSimpleName

private String typeBuilderSimpleName()

factoryBuilder

@Lazy
public Constitution.AppliedNameForms factoryBuilder()

factoryImplementationBuilder

private Constitution.AppliedNameForms factoryImplementationBuilder()

isOutsideBuilderNotNested

public boolean isOutsideBuilderNotNested()

isConstantNamingEquals

private boolean isConstantNamingEquals(Naming naming,
 String name)

factoryOf

@Lazy
public Constitution.AppliedNameForms factoryOf()

factoryInstance

@Lazy
public Constitution.AppliedNameForms factoryInstance()

factoryCopyOf

@Lazy
public Constitution.AppliedNameForms factoryCopyOf()

applyFactoryNaming

private Constitution.AppliedNameForms applyFactoryNaming(Naming naming)

typeEnclosingFactory

@Lazy
public Constitution.NameForms typeEnclosingFactory()

typeEnclosing

@Lazy
public Constitution.NameForms typeEnclosing()

implementationEnclosingVisibility

private Visibility implementationEnclosingVisibility()

typeWith

@Lazy
public Constitution.NameForms typeWith()

typeBuilder

@Lazy
public Constitution.NameForms typeBuilder()

typeImplementationBuilder

@Lazy
public Constitution.NameForms typeImplementationBuilder()

innerBuilder

@Lazy
public Constitution.InnerBuilderDefinition innerBuilder()

innerModifiable

@Lazy
public Constitution.InnerModifiableDefinition innerModifiable()