org.inferred.freebuilder.processor

Class Metadata.Property

java.lang.Object

org.inferred.freebuilder.processor.Metadata.Property

Enclosing class:

Metadata

public abstract static class Metadata.Property
extends java.lang.Object

Metadata about a property of a Metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metadata.Property.Builder Builder for Metadata.Property.

Constructor Summary

Constructors

Constructor and Description
Property()

Method Summary

Modifier and Type	Method and Description
abstract com.google.common.collect.ImmutableList<Excerpt>	getAccessorAnnotations() Returns a list of annotations that should be applied to the accessor methods of this property; that is, the getter method, and a single setter method that will accept the result of the getter method as its argument.
abstract java.lang.String	getAllCapsName() Returns the name of the property in all-caps with underscores, e.g.
abstract javax.lang.model.type.TypeMirror	getBoxedType() Returns the boxed form of getType(), or null if type is not primitive.
abstract java.lang.String	getCapitalizedName() Returns the capitalized name of the property, e.g.
abstract PropertyCodeGenerator	getCodeGenerator() Returns the code generator to use for this property, or null if no generator has been picked (i.e.
FieldAccess	getField() Returns the field name that stores the property, e.g.
abstract java.lang.String	getGetterName() Returns the name of the getter for the property, e.g.
abstract java.lang.String	getName() Returns the name of the property, e.g.
abstract javax.lang.model.type.TypeMirror	getType() Returns the type of the property.
abstract boolean	isFullyCheckedCast() Returns true if a cast to this property type is guaranteed to be fully checked at runtime.
abstract boolean	isUsingBeanConvention() Returns true if getters start with "get"; setters should follow suit with "set".
Metadata.Property.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property()

Method Detail

getType

public abstract javax.lang.model.type.TypeMirror getType()

Returns the type of the property.

getBoxedType

@Nullable
public abstract javax.lang.model.type.TypeMirror getBoxedType()

Returns the boxed form of getType(), or null if type is not primitive.

getName

public abstract java.lang.String getName()

Returns the name of the property, e.g. myProperty.

getField

public FieldAccess getField()

Returns the field name that stores the property, e.g. myProperty.

getCapitalizedName

public abstract java.lang.String getCapitalizedName()

Returns the capitalized name of the property, e.g. MyProperty.

getAllCapsName

public abstract java.lang.String getAllCapsName()

Returns the name of the property in all-caps with underscores, e.g. MY_PROPERTY.

isUsingBeanConvention

public abstract boolean isUsingBeanConvention()

Returns true if getters start with "get"; setters should follow suit with "set".

getGetterName

public abstract java.lang.String getGetterName()

Returns the name of the getter for the property, e.g. getMyProperty, or isSomethingTrue.

getCodeGenerator

@Nullable
public abstract PropertyCodeGenerator getCodeGenerator()

Returns the code generator to use for this property, or null if no generator has been picked (i.e. when passed to PropertyCodeGenerator.Factory.create(org.inferred.freebuilder.processor.PropertyCodeGenerator.Config).

isFullyCheckedCast

public abstract boolean isFullyCheckedCast()

Returns true if a cast to this property type is guaranteed to be fully checked at runtime. This is true for any type that is non-generic, raw, or parameterized with unbounded wildcards, such as Integer, List or Map<?, ?>.

getAccessorAnnotations

public abstract com.google.common.collect.ImmutableList<Excerpt> getAccessorAnnotations()

Returns a list of annotations that should be applied to the accessor methods of this property; that is, the getter method, and a single setter method that will accept the result of the getter method as its argument. For a list, for example, that would be getX() and addAllX().

toBuilder

public Metadata.Property.Builder toBuilder()