org.inferred.freebuilder.processor

Interface Metadata.Property

Enclosing class:

Metadata

public static interface Metadata.Property

Metadata about a property of a Metadata.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<AnnotationMirror>	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.
String	getAllCapsName() Returns the name of the property in all-caps with underscores, e.g.
TypeMirror	getBoxedType() Returns the boxed form of getType(), or null if type is not primitive.
String	getCapitalizedName() Returns the capitalized name of the property, e.g.
PropertyCodeGenerator	getCodeGenerator() Returns the code generator to use for this property, or null if no generator has been picked (i.e.
String	getGetterName() Returns the name of the getter for the property, e.g.
String	getName() Returns the name of the property, e.g.
com.google.common.collect.ImmutableSet<TypeElement>	getNullableAnnotations() Returns the @Nullable annotations that have been applied to this property.
TypeMirror	getType() Returns the type of the property.
boolean	isFullyCheckedCast() Returns true if a cast to this property type is guaranteed to be fully checked at runtime.

Method Detail

getType

TypeMirror getType()

Returns the type of the property.

getBoxedType

@Nullable
TypeMirror getBoxedType()

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

getName

String getName()

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

getCapitalizedName

String getCapitalizedName()

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

getAllCapsName

String getAllCapsName()

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

getGetterName

String getGetterName()

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

getCodeGenerator

@Nullable
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

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<?, ?>.

getNullableAnnotations

com.google.common.collect.ImmutableSet<TypeElement> getNullableAnnotations()

Returns the @Nullable annotations that have been applied to this property.

getAccessorAnnotations

com.google.common.collect.ImmutableList<AnnotationMirror> 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().