Package org.immutables.value.processor.meta

Class Proto.Protoclass

java.lang.Object

org.immutables.value.processor.meta.Proto.Diagnosable

org.immutables.value.processor.meta.Proto.Protoclass

Direct Known Subclasses:

ImmutableProto.Protoclass

Enclosing class:

Proto

@Immutable
public abstract static class Proto.Protoclass
extends Proto.Diagnosable

Prototypical model for generated derived classes. Protoclass could be used to projects different kind of derived classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Proto.Protoclass.Kind

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<java.lang.String>	debugLines

Constructor Summary

Constructors

Constructor	Description
Protoclass()

Method Summary

Modifier and Type	Method	Description
Constitution	constitution()
(package private) Styles.UsingName.TypeNames	createTypeNames()
com.google.common.base.Optional<CriteriaMirror>	criteria()
com.google.common.base.Optional<CriteriaRepositoryMirror>	criteriaRepository()
com.google.common.base.Optional<DataMirror>	datatypeMarker()
com.google.common.base.Optional<Proto.AbstractDeclaring>	datatypeProvider()
(package private) Proto.Protoclass	debug(java.lang.String line)
abstract com.google.common.base.Optional<Proto.DeclaringType>	declaringType()	The class, which is annotated to be a @Value.Immutable, @Value.Include or @Value.Enclosing.
Visibility	declaringVisibility()
com.google.common.base.Optional<java.lang.String[]>	depluralize()
private com.google.common.base.Optional<StyleInfo>	determineStyle()
javax.lang.model.element.Element	element()	Element used mostly for error reporting, real model provided by sourceElement().
com.google.common.base.Optional<Proto.DeclaringType>	enclosingOf()
Instantiator	encodingInstantiator()
ValueImmutableInfo	features()
(package private) java.util.List<java.lang.String>	getDebugLines()
com.google.common.base.Optional<TransformMirror>	getTransform()
com.google.common.base.Optional<TreesIncludeMirror>	getTreesInclude()
com.google.common.base.Optional<VisitMirror>	getVisit()
com.google.common.base.Optional<TypeAdaptersMirror>	gsonTypeAdapters()
boolean	isAst()
boolean	isJacksonDeserialized()
boolean	isJacksonJsonTypeInfo()
boolean	isJacksonProperties()
boolean	isJacksonSerialized()
boolean	isSerialStructural()
boolean	isTransformer()
boolean	isVisitor()
abstract Proto.Protoclass.Kind	kind()	Kind of protoclass declaration, it specifies how exactly the protoclass was declared.
java.lang.String	name()
com.google.common.base.Optional<OkTypeAdaptersMirror>	okJsonTypeAdapters()
com.google.common.base.Optional<Proto.AbstractDeclaring>	okTypeAdaptersProvider()
abstract Proto.DeclaringPackage	packageOf()	Declaring package that defines value type (usually by import).
com.google.common.base.Optional<RepositoryMirror>	repository()
com.google.common.base.Optional<java.lang.Long>	serialVersion()
abstract javax.lang.model.element.Element	sourceElement()	Source type elements stores type element which is used as a source of value type model.
Styles	styles()
com.google.common.base.Optional<Proto.AbstractDeclaring>	typeAdaptersProvider()
Visibility	visibility()
private void	warnAboutIncompatibleStyles()

Methods inherited from class org.immutables.value.processor.meta.Proto.Diagnosable

environment, processing, report, simpleName

Methods inherited from class java.lang.Object

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

Field Detail

debugLines

private java.util.List<java.lang.String> debugLines

Constructor Detail

Protoclass

public Protoclass()

Method Detail

name

@Derived
public java.lang.String name()

sourceElement

@Auxiliary
public abstract javax.lang.model.element.Element sourceElement()

Source type elements stores type element which is used as a source of value type model. It is the annotated class for @Value.Immutable or type referenced in @Value.Include.

Returns:

source element

packageOf

public abstract Proto.DeclaringPackage packageOf()

Declaring package that defines value type (usually by import). Or the package in which declaringType() resides.

Returns:

declaring package

declaringType

public abstract com.google.common.base.Optional<Proto.DeclaringType> declaringType()

The class, which is annotated to be a @Value.Immutable, @Value.Include or @Value.Enclosing.

Returns:

declaring type

criteria

@Lazy
public com.google.common.base.Optional<CriteriaMirror> criteria()

repository

@Lazy
public com.google.common.base.Optional<RepositoryMirror> repository()

criteriaRepository

@Lazy
public com.google.common.base.Optional<CriteriaRepositoryMirror> criteriaRepository()

gsonTypeAdapters

@Lazy
public com.google.common.base.Optional<TypeAdaptersMirror> gsonTypeAdapters()

typeAdaptersProvider

@Lazy
public com.google.common.base.Optional<Proto.AbstractDeclaring> typeAdaptersProvider()

okJsonTypeAdapters

@Lazy
public com.google.common.base.Optional<OkTypeAdaptersMirror> okJsonTypeAdapters()

okTypeAdaptersProvider

@Lazy
public com.google.common.base.Optional<Proto.AbstractDeclaring> okTypeAdaptersProvider()

datatypeMarker

@Lazy
public com.google.common.base.Optional<DataMirror> datatypeMarker()

datatypeProvider

@Lazy
public com.google.common.base.Optional<Proto.AbstractDeclaring> datatypeProvider()

kind

public abstract Proto.Protoclass.Kind kind()

Kind of protoclass declaration, it specifies how exactly the protoclass was declared.

Returns:

definition kind

visibility

@Derived
public Visibility visibility()

declaringVisibility

public Visibility declaringVisibility()

element

@Derived
@Auxiliary
public javax.lang.model.element.Element element()

Element used mostly for error reporting, real model provided by sourceElement().

Specified by:

element in class Proto.Diagnosable

serialVersion

@Lazy
public com.google.common.base.Optional<java.lang.Long> serialVersion()

isSerialStructural

@Lazy
public boolean isSerialStructural()

isJacksonSerialized

@Lazy
public boolean isJacksonSerialized()

isJacksonDeserialized

@Lazy
public boolean isJacksonDeserialized()

features

@Lazy
public ValueImmutableInfo features()

styles

@Lazy
public Styles styles()

depluralize

@Lazy
public com.google.common.base.Optional<java.lang.String[]> depluralize()

determineStyle

private com.google.common.base.Optional<StyleInfo> determineStyle()

warnAboutIncompatibleStyles

private void warnAboutIncompatibleStyles()

enclosingOf

@Derived
@Auxiliary
public com.google.common.base.Optional<Proto.DeclaringType> enclosingOf()

createTypeNames

Styles.UsingName.TypeNames createTypeNames()

isJacksonJsonTypeInfo

@Lazy
public boolean isJacksonJsonTypeInfo()

isAst

public boolean isAst()

isTransformer

public boolean isTransformer()

isVisitor

public boolean isVisitor()

getTransform

public com.google.common.base.Optional<TransformMirror> getTransform()

getVisit

public com.google.common.base.Optional<VisitMirror> getVisit()

getTreesInclude

public com.google.common.base.Optional<TreesIncludeMirror> getTreesInclude()

constitution

@Lazy
public Constitution constitution()

encodingInstantiator

@Lazy
public Instantiator encodingInstantiator()

isJacksonProperties

public boolean isJacksonProperties()

debug

Proto.Protoclass debug(java.lang.String line)

getDebugLines

java.util.List<java.lang.String> getDebugLines()