Class OptionalProperty

java.lang.Object

org.inferred.freebuilder.processor.property.PropertyCodeGenerator

org.inferred.freebuilder.processor.property.OptionalProperty

class OptionalProperty
extends PropertyCodeGenerator

PropertyCodeGenerator providing a default value (absent/empty) and convenience setter methods for Guava and Java 8 Optional properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	OptionalProperty.Factory
(package private) static enum	OptionalProperty.OptionalType

Nested classes/interfaces inherited from class PropertyCodeGenerator

PropertyCodeGenerator.Config, PropertyCodeGenerator.Initially

Field Summary

Fields

Modifier and Type	Field	Description
private final TypeMirror	elementType
private final FunctionalType	mapperType
private final OptionalProperty.OptionalType	optional
private final Optional<TypeMirror>	unboxedType

Fields inherited from class PropertyCodeGenerator

datatype, property

Constructor Summary

Constructors

Constructor	Description
OptionalProperty(Datatype datatype, Property property, OptionalProperty.OptionalType optional, TypeMirror elementType, Optional<TypeMirror> unboxedType, FunctionalType mapperType)

Method Summary

Modifier and Type	Method	Description
void	addAssignToBuilder(SourceBuilder code, Variable builder)	Adds an assignment to the field on the builder from the Value/Partial implementation.
void	addBuilderFieldAccessors(SourceBuilder code)	Add the accessor methods for the property to the builder's source code.
void	addBuilderFieldDeclaration(SourceBuilder code)	Add the field declaration for the property to the builder's source code.
private void	addClear(SourceBuilder code)
void	addClearField(SourceBuilder code)	Adds a clear call for the property given a template builder to the builder's source code.
void	addFinalFieldAssignment(SourceBuilder code, Excerpt finalField, String builder)	Add the final assignment of the property to the value object's source code.
private void	addGetter(SourceBuilder code)
private void	addMapper(SourceBuilder code)
void	addMergeFromBuilder(SourceBuilder code, String builder)	Add a merge from builder for the property to the builder's source code.
void	addMergeFromValue(SourceBuilder code, String value)	Add a merge from value for the property to the builder's source code.
private void	addNullableSetter(SourceBuilder code)
private void	addOptionalSetter(SourceBuilder code)
void	addReadValueFragment(SourceBuilder code, Excerpt finalField)	Adds a fragment converting the value object's field to the property's type.
void	addSetFromResult(SourceBuilder code, Excerpt builder, Excerpt variable)	Adds a set call for the property from a function result to the builder's source code.
private void	addSetter(SourceBuilder code)
void	addValueFieldDeclaration(SourceBuilder code)	Add the field declaration for the property to the value's source code.
Set<MergeAction>	getMergeActions()	Returns the actions taken in mergeFrom, for generating JavaDoc.
PropertyCodeGenerator.Initially	initialState()	Returns whether the property is required, optional, or has a default.

Methods inherited from class PropertyCodeGenerator

addAccessorAnnotations, addGetterAnnotations, addPartialFieldAssignment, addPutAnnotations, addToStringCondition, addToStringValue, equals, hashCode, toString

Methods inherited from class Object

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

Field Details

optional

private final OptionalProperty.OptionalType optional

elementType

private final TypeMirror elementType

unboxedType

private final Optional<TypeMirror> unboxedType

mapperType

private final FunctionalType mapperType

Constructor Details

OptionalProperty

OptionalProperty(Datatype datatype,
 Property property,
 OptionalProperty.OptionalType optional,
 TypeMirror elementType,
 Optional<TypeMirror> unboxedType,
 FunctionalType mapperType)

Method Details

initialState

public PropertyCodeGenerator.Initially initialState()

Description copied from class: PropertyCodeGenerator

Returns whether the property is required, optional, or has a default.

Overrides:

initialState in class PropertyCodeGenerator

addValueFieldDeclaration

public void addValueFieldDeclaration(SourceBuilder code)

Description copied from class: PropertyCodeGenerator

Add the field declaration for the property to the value's source code.

Specified by:

addValueFieldDeclaration in class PropertyCodeGenerator

addBuilderFieldDeclaration

public void addBuilderFieldDeclaration(SourceBuilder code)

Description copied from class: PropertyCodeGenerator

Add the field declaration for the property to the builder's source code.

Specified by:

addBuilderFieldDeclaration in class PropertyCodeGenerator

addBuilderFieldAccessors

public void addBuilderFieldAccessors(SourceBuilder code)

Description copied from class: PropertyCodeGenerator

Add the accessor methods for the property to the builder's source code.

Specified by:

addBuilderFieldAccessors in class PropertyCodeGenerator

addSetter

private void addSetter(SourceBuilder code)

addOptionalSetter

private void addOptionalSetter(SourceBuilder code)

addNullableSetter

private void addNullableSetter(SourceBuilder code)

addMapper

private void addMapper(SourceBuilder code)

addClear

private void addClear(SourceBuilder code)

addGetter

private void addGetter(SourceBuilder code)

addFinalFieldAssignment

public void addFinalFieldAssignment(SourceBuilder code,
 Excerpt finalField,
 String builder)

Description copied from class: PropertyCodeGenerator

Add the final assignment of the property to the value object's source code.

Specified by:

addFinalFieldAssignment in class PropertyCodeGenerator

addAssignToBuilder

public void addAssignToBuilder(SourceBuilder code,
 Variable builder)

Description copied from class: PropertyCodeGenerator

Adds an assignment to the field on the builder from the Value/Partial implementation.

Specified by:

addAssignToBuilder in class PropertyCodeGenerator

addMergeFromValue

public void addMergeFromValue(SourceBuilder code,
 String value)

Description copied from class: PropertyCodeGenerator

Add a merge from value for the property to the builder's source code.

Specified by:

addMergeFromValue in class PropertyCodeGenerator

addMergeFromBuilder

public void addMergeFromBuilder(SourceBuilder code,
 String builder)

Description copied from class: PropertyCodeGenerator

Add a merge from builder for the property to the builder's source code.

Specified by:

addMergeFromBuilder in class PropertyCodeGenerator

getMergeActions

public Set<MergeAction> getMergeActions()

Description copied from class: PropertyCodeGenerator

Returns the actions taken in mergeFrom, for generating JavaDoc.

Specified by:

getMergeActions in class PropertyCodeGenerator

addReadValueFragment

public void addReadValueFragment(SourceBuilder code,
 Excerpt finalField)

Description copied from class: PropertyCodeGenerator

Adds a fragment converting the value object's field to the property's type.

Overrides:

addReadValueFragment in class PropertyCodeGenerator

addSetFromResult

public void addSetFromResult(SourceBuilder code,
 Excerpt builder,
 Excerpt variable)

Description copied from class: PropertyCodeGenerator

Adds a set call for the property from a function result to the builder's source code.

Specified by:

addSetFromResult in class PropertyCodeGenerator

addClearField

public void addClearField(SourceBuilder code)

Description copied from class: PropertyCodeGenerator

Adds a clear call for the property given a template builder to the builder's source code.

Specified by:

addClearField in class PropertyCodeGenerator