com.google.auto.value.processor

Class AutoValueProcessor.Property

java.lang.Object

com.google.auto.value.processor.AutoValueProcessor.Property

Enclosing class:

AutoValueProcessor

public static class AutoValueProcessor.Property
extends java.lang.Object

A property of an @AutoValue class, defined by one of its abstract methods. An instance of this class is made available to the Velocity template engine for each property. The public methods of this class define JavaBeans-style properties that are accessible from templates. For example getType() means we can write $p.type for a Velocity variable $p that is a Property.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccess()
java.util.List<java.lang.String>	getAnnotations()
java.lang.String	getGetter() Returns the name of the getter method for this property as defined by the @AutoValue class.
javax.lang.model.type.TypeKind	getKind()
java.lang.String	getName() Returns the name of the property as it should be used in strings visible to users.
java.lang.String	getNullableAnnotation() Returns the string to use as a method annotation to indicate the nullability of this property.
Optionalish	getOptional() Returns an Optionalish representing the kind of Optional that this property's type is, or null if the type is not an Optional of any kind.
java.lang.String	getType()
javax.lang.model.type.TypeMirror	getTypeMirror()
int	hashCode()
boolean	isNullable()
java.lang.String	toString() Returns the name of the property as it should be used when declaring identifiers (fields and parameters).

Methods inherited from class java.lang.Object

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

Method Detail

toString

public java.lang.String toString()

Returns the name of the property as it should be used when declaring identifiers (fields and parameters). If the original getter method was foo() then this will be foo. If it was getFoo() then it will be foo. If it was getPackage() then it will be something like package0, since package is a reserved word.

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Returns the name of the property as it should be used in strings visible to users. This is usually the same as toString(), except that if we had to use an identifier like "package0" because "package" is a reserved word, the name here will be the original "package".

getGetter

public java.lang.String getGetter()

Returns the name of the getter method for this property as defined by the @AutoValue class. For property foo, this will be foo or getFoo or isFoo.

getTypeMirror

public javax.lang.model.type.TypeMirror getTypeMirror()

getType

public java.lang.String getType()

getKind

public javax.lang.model.type.TypeKind getKind()

getAnnotations

public java.util.List<java.lang.String> getAnnotations()

getOptional

public Optionalish getOptional()

Returns an Optionalish representing the kind of Optional that this property's type is, or null if the type is not an Optional of any kind.

getNullableAnnotation

public final java.lang.String getNullableAnnotation()

Returns the string to use as a method annotation to indicate the nullability of this property. It is either the empty string, if the property is not nullable, or an annotation string with a trailing space, such as "@`javax.annotation.Nullable` ", where the `` is the encoding used by TypeEncoder. If the property is nullable by virtue of its type rather than its method being @Nullable, this method returns the empty string, because the @Nullable will appear when the type is spelled out.

isNullable

public boolean isNullable()

getAccess

public java.lang.String getAccess()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object