Class Property_Builder

java.lang.Object

org.inferred.freebuilder.processor.property.Property_Builder

Direct Known Subclasses:

Property.Builder

@Generated("org.inferred.freebuilder.processor.Processor")
abstract class Property_Builder
extends Object

Auto-generated superclass of

invalid reference

Property.Builder

, derived from the API of Property_Builder.Property.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	Property_Builder.Partial
private static enum	Property_Builder.Property
private static class	Property_Builder.Rebuildable
private static final class	Property_Builder.Value

Field Summary

Fields

Modifier and Type	Field	Description
private final EnumSet<Property_Builder.Property>	_unsetProperties
private List<Excerpt>	accessorAnnotations
private String	allCapsName
private TypeMirror	boxedType
private String	capitalizedName
private boolean	fullyCheckedCast
private List<Excerpt>	getterAnnotations
private String	getterName
private boolean	inEqualsAndHashCode
private boolean	inToString
private String	name
private List<Excerpt>	putAnnotations
private TypeMirror	type
private boolean	usingBeanConvention

Constructor Summary

Constructors

Constructor	Description
Property_Builder()

Method Summary

Modifier and Type	Method	Description
Property.Builder	addAccessorAnnotations(Excerpt element)	Adds element to the list to be returned from Property.getAccessorAnnotations().
Property.Builder	addAccessorAnnotations(Excerpt... elements)	Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().
Property.Builder	addAllAccessorAnnotations(Iterable<? extends Excerpt> elements)	Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().
Property.Builder	addAllAccessorAnnotations(Spliterator<? extends Excerpt> elements)	Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().
Property.Builder	addAllAccessorAnnotations(BaseStream<? extends Excerpt, ?> elements)	Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().
Property.Builder	addAllGetterAnnotations(Iterable<? extends Excerpt> elements)	Adds each element of elements to the list to be returned from Property.getGetterAnnotations().
Property.Builder	addAllGetterAnnotations(Spliterator<? extends Excerpt> elements)	Adds each element of elements to the list to be returned from Property.getGetterAnnotations().
Property.Builder	addAllGetterAnnotations(BaseStream<? extends Excerpt, ?> elements)	Adds each element of elements to the list to be returned from Property.getGetterAnnotations().
Property.Builder	addAllPutAnnotations(Iterable<? extends Excerpt> elements)	Adds each element of elements to the list to be returned from Property.getPutAnnotations().
Property.Builder	addAllPutAnnotations(Spliterator<? extends Excerpt> elements)	Adds each element of elements to the list to be returned from Property.getPutAnnotations().
Property.Builder	addAllPutAnnotations(BaseStream<? extends Excerpt, ?> elements)	Adds each element of elements to the list to be returned from Property.getPutAnnotations().
Property.Builder	addGetterAnnotations(Excerpt element)	Adds element to the list to be returned from Property.getGetterAnnotations().
Property.Builder	addGetterAnnotations(Excerpt... elements)	Adds each element of elements to the list to be returned from Property.getGetterAnnotations().
Property.Builder	addPutAnnotations(Excerpt element)	Adds element to the list to be returned from Property.getPutAnnotations().
Property.Builder	addPutAnnotations(Excerpt... elements)	Adds each element of elements to the list to be returned from Property.getPutAnnotations().
Property	build()	Returns a newly-created Property based on the contents of this Builder.
Property	buildPartial()	Returns a newly-created partial Property for use in unit tests.
Property.Builder	clear()	Resets the state of this builder.
Property.Builder	clearAccessorAnnotations()	Clears the list to be returned from Property.getAccessorAnnotations().
Property.Builder	clearBoxedType()	Sets the value to be returned by Property.getBoxedType() to Optional.empty().
Property.Builder	clearGetterAnnotations()	Clears the list to be returned from Property.getGetterAnnotations().
Property.Builder	clearPutAnnotations()	Clears the list to be returned from Property.getPutAnnotations().
static Property.Builder	from(Property value)	Creates a new builder using value as a template.
List<Excerpt>	getAccessorAnnotations()	Returns an unmodifiable view of the list that will be returned by Property.getAccessorAnnotations().
String	getAllCapsName()	Returns the value that will be returned by Property.getAllCapsName().
Optional<TypeMirror>	getBoxedType()	Returns the value that will be returned by Property.getBoxedType().
String	getCapitalizedName()	Returns the value that will be returned by Property.getCapitalizedName().
List<Excerpt>	getGetterAnnotations()	Returns an unmodifiable view of the list that will be returned by Property.getGetterAnnotations().
String	getGetterName()	Returns the value that will be returned by Property.getGetterName().
String	getName()	Returns the value that will be returned by Property.getName().
List<Excerpt>	getPutAnnotations()	Returns an unmodifiable view of the list that will be returned by Property.getPutAnnotations().
TypeMirror	getType()	Returns the value that will be returned by Property.getType().
boolean	isFullyCheckedCast()	Returns the value that will be returned by Property.isFullyCheckedCast().
boolean	isInEqualsAndHashCode()	Returns the value that will be returned by Property.isInEqualsAndHashCode().
boolean	isInToString()	Returns the value that will be returned by Property.isInToString().
boolean	isUsingBeanConvention()	Returns the value that will be returned by Property.isUsingBeanConvention().
Property.Builder	mapAllCapsName(UnaryOperator<String> mapper)	Replaces the value to be returned by Property.getAllCapsName() by applying mapper to it and using the result.
Property.Builder	mapBoxedType(UnaryOperator<TypeMirror> mapper)	If the value to be returned by Property.getBoxedType() is present, replaces it by applying mapper to it and using the result.
Property.Builder	mapCapitalizedName(UnaryOperator<String> mapper)	Replaces the value to be returned by Property.getCapitalizedName() by applying mapper to it and using the result.
Property.Builder	mapFullyCheckedCast(UnaryOperator<Boolean> mapper)	Replaces the value to be returned by Property.isFullyCheckedCast() by applying mapper to it and using the result.
Property.Builder	mapGetterName(UnaryOperator<String> mapper)	Replaces the value to be returned by Property.getGetterName() by applying mapper to it and using the result.
Property.Builder	mapInEqualsAndHashCode(UnaryOperator<Boolean> mapper)	Replaces the value to be returned by Property.isInEqualsAndHashCode() by applying mapper to it and using the result.
Property.Builder	mapInToString(UnaryOperator<Boolean> mapper)	Replaces the value to be returned by Property.isInToString() by applying mapper to it and using the result.
Property.Builder	mapName(UnaryOperator<String> mapper)	Replaces the value to be returned by Property.getName() by applying mapper to it and using the result.
Property.Builder	mapType(UnaryOperator<TypeMirror> mapper)	Replaces the value to be returned by Property.getType() by applying mapper to it and using the result.
Property.Builder	mapUsingBeanConvention(UnaryOperator<Boolean> mapper)	Replaces the value to be returned by Property.isUsingBeanConvention() by applying mapper to it and using the result.
Property.Builder	mergeFrom(Property value)	Copies values from value, appending to collections, and skipping defaults and empty optionals.
Property.Builder	mergeFrom(Property.Builder template)	Copies values from template, appending to collections, and skipping defaults, empty optionals and unset properties.
Property.Builder	mutateAccessorAnnotations(Consumer<? super List<Excerpt>> mutator)	Applies mutator to the list to be returned from Property.getAccessorAnnotations().
Property.Builder	mutateGetterAnnotations(Consumer<? super List<Excerpt>> mutator)	Applies mutator to the list to be returned from Property.getGetterAnnotations().
Property.Builder	mutatePutAnnotations(Consumer<? super List<Excerpt>> mutator)	Applies mutator to the list to be returned from Property.getPutAnnotations().
Property.Builder	setAllCapsName(String allCapsName)	Sets the value to be returned by Property.getAllCapsName().
Property.Builder	setBoxedType(Optional<? extends TypeMirror> boxedType)	Sets the value to be returned by Property.getBoxedType().
Property.Builder	setBoxedType(TypeMirror boxedType)	Sets the value to be returned by Property.getBoxedType().
Property.Builder	setCapitalizedName(String capitalizedName)	Sets the value to be returned by Property.getCapitalizedName().
Property.Builder	setFullyCheckedCast(boolean fullyCheckedCast)	Sets the value to be returned by Property.isFullyCheckedCast().
Property.Builder	setGetterName(String getterName)	Sets the value to be returned by Property.getGetterName().
Property.Builder	setInEqualsAndHashCode(boolean inEqualsAndHashCode)	Sets the value to be returned by Property.isInEqualsAndHashCode().
Property.Builder	setInToString(boolean inToString)	Sets the value to be returned by Property.isInToString().
Property.Builder	setName(String name)	Sets the value to be returned by Property.getName().
Property.Builder	setNullableBoxedType(TypeMirror boxedType)	Sets the value to be returned by Property.getBoxedType().
Property.Builder	setType(TypeMirror type)	Sets the value to be returned by Property.getType().
Property.Builder	setUsingBeanConvention(boolean usingBeanConvention)	Sets the value to be returned by Property.isUsingBeanConvention().

Methods inherited from class Object

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

Field Details

type

private TypeMirror type

boxedType

private TypeMirror boxedType

name

private String name

capitalizedName

private String capitalizedName

allCapsName

private String allCapsName

usingBeanConvention

private boolean usingBeanConvention

inToString

private boolean inToString

inEqualsAndHashCode

private boolean inEqualsAndHashCode

getterName

private String getterName

fullyCheckedCast

private boolean fullyCheckedCast

accessorAnnotations

private List<Excerpt> accessorAnnotations

getterAnnotations

private List<Excerpt> getterAnnotations

putAnnotations

private List<Excerpt> putAnnotations

_unsetProperties

private final EnumSet<Property_Builder.Property> _unsetProperties

Constructor Details

Property_Builder

Property_Builder()

Method Details

from

public static Property.Builder from(Property value)

Creates a new builder using value as a template.

If value is a partial, the builder will return more partials.

setType

public Property.Builder setType(TypeMirror type)

Sets the value to be returned by Property.getType().

Returns:

this Builder object

Throws:

NullPointerException - if type is null

mapType

public Property.Builder mapType(UnaryOperator<TypeMirror> mapper)

Replaces the value to be returned by Property.getType() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

IllegalStateException - if the field has not been set

getType

public TypeMirror getType()

Returns the value that will be returned by Property.getType().

Throws:

IllegalStateException - if the field has not been set

setBoxedType

public Property.Builder setBoxedType(TypeMirror boxedType)

Sets the value to be returned by Property.getBoxedType().

Returns:

this Builder object

Throws:

NullPointerException - if boxedType is null

setBoxedType

public Property.Builder setBoxedType(Optional<? extends TypeMirror> boxedType)

Sets the value to be returned by Property.getBoxedType().

Returns:

this Builder object

setNullableBoxedType

public Property.Builder setNullableBoxedType(TypeMirror boxedType)

Sets the value to be returned by Property.getBoxedType().

Returns:

this Builder object

mapBoxedType

public Property.Builder mapBoxedType(UnaryOperator<TypeMirror> mapper)

If the value to be returned by Property.getBoxedType() is present, replaces it by applying mapper to it and using the result.

If the result is null, clears the value.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null

clearBoxedType

public Property.Builder clearBoxedType()

Sets the value to be returned by Property.getBoxedType() to Optional.empty().

Returns:

this Builder object

getBoxedType

public Optional<TypeMirror> getBoxedType()

Returns the value that will be returned by Property.getBoxedType().

setName

public Property.Builder setName(String name)

Sets the value to be returned by Property.getName().

Returns:

this Builder object

Throws:

NullPointerException - if name is null

mapName

public Property.Builder mapName(UnaryOperator<String> mapper)

Replaces the value to be returned by Property.getName() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

IllegalStateException - if the field has not been set

getName

public String getName()

Returns the value that will be returned by Property.getName().

Throws:

IllegalStateException - if the field has not been set

setCapitalizedName

public Property.Builder setCapitalizedName(String capitalizedName)

Sets the value to be returned by Property.getCapitalizedName().

Returns:

this Builder object

Throws:

NullPointerException - if capitalizedName is null

mapCapitalizedName

public Property.Builder mapCapitalizedName(UnaryOperator<String> mapper)

Replaces the value to be returned by Property.getCapitalizedName() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

IllegalStateException - if the field has not been set

getCapitalizedName

public String getCapitalizedName()

Returns the value that will be returned by Property.getCapitalizedName().

Throws:

IllegalStateException - if the field has not been set

setAllCapsName

public Property.Builder setAllCapsName(String allCapsName)

Sets the value to be returned by Property.getAllCapsName().

Returns:

this Builder object

Throws:

NullPointerException - if allCapsName is null

mapAllCapsName

public Property.Builder mapAllCapsName(UnaryOperator<String> mapper)

Replaces the value to be returned by Property.getAllCapsName() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

IllegalStateException - if the field has not been set

getAllCapsName

public String getAllCapsName()

Returns the value that will be returned by Property.getAllCapsName().

Throws:

IllegalStateException - if the field has not been set

setUsingBeanConvention

public Property.Builder setUsingBeanConvention(boolean usingBeanConvention)

Sets the value to be returned by Property.isUsingBeanConvention().

Returns:

this Builder object

mapUsingBeanConvention

public Property.Builder mapUsingBeanConvention(UnaryOperator<Boolean> mapper)

Replaces the value to be returned by Property.isUsingBeanConvention() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

IllegalStateException - if the field has not been set

isUsingBeanConvention

public boolean isUsingBeanConvention()

Returns the value that will be returned by Property.isUsingBeanConvention().

Throws:

IllegalStateException - if the field has not been set

setInToString

public Property.Builder setInToString(boolean inToString)

Sets the value to be returned by Property.isInToString().

Returns:

this Builder object

mapInToString

public Property.Builder mapInToString(UnaryOperator<Boolean> mapper)

Replaces the value to be returned by Property.isInToString() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

isInToString

public boolean isInToString()

Returns the value that will be returned by Property.isInToString().

setInEqualsAndHashCode

public Property.Builder setInEqualsAndHashCode(boolean inEqualsAndHashCode)

Sets the value to be returned by Property.isInEqualsAndHashCode().

Returns:

this Builder object

mapInEqualsAndHashCode

public Property.Builder mapInEqualsAndHashCode(UnaryOperator<Boolean> mapper)

Replaces the value to be returned by Property.isInEqualsAndHashCode() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

isInEqualsAndHashCode

public boolean isInEqualsAndHashCode()

Returns the value that will be returned by Property.isInEqualsAndHashCode().

setGetterName

public Property.Builder setGetterName(String getterName)

Sets the value to be returned by Property.getGetterName().

Returns:

this Builder object

Throws:

NullPointerException - if getterName is null

mapGetterName

public Property.Builder mapGetterName(UnaryOperator<String> mapper)

Replaces the value to be returned by Property.getGetterName() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

IllegalStateException - if the field has not been set

getGetterName

public String getGetterName()

Returns the value that will be returned by Property.getGetterName().

Throws:

IllegalStateException - if the field has not been set

setFullyCheckedCast

public Property.Builder setFullyCheckedCast(boolean fullyCheckedCast)

Sets the value to be returned by Property.isFullyCheckedCast().

Returns:

this Builder object

mapFullyCheckedCast

public Property.Builder mapFullyCheckedCast(UnaryOperator<Boolean> mapper)

Replaces the value to be returned by Property.isFullyCheckedCast() by applying mapper to it and using the result.

Returns:

this Builder object

Throws:

NullPointerException - if mapper is null or returns null

IllegalStateException - if the field has not been set

isFullyCheckedCast

public boolean isFullyCheckedCast()

Returns the value that will be returned by Property.isFullyCheckedCast().

Throws:

IllegalStateException - if the field has not been set

addAccessorAnnotations

public Property.Builder addAccessorAnnotations(Excerpt element)

Adds element to the list to be returned from Property.getAccessorAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if element is null

addAccessorAnnotations

public Property.Builder addAccessorAnnotations(Excerpt... elements)

Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

addAllAccessorAnnotations

public Property.Builder addAllAccessorAnnotations(Spliterator<? extends Excerpt> elements)

Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

addAllAccessorAnnotations

public Property.Builder addAllAccessorAnnotations(BaseStream<? extends Excerpt, ?> elements)

Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

addAllAccessorAnnotations

public Property.Builder addAllAccessorAnnotations(Iterable<? extends Excerpt> elements)

Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

mutateAccessorAnnotations

public Property.Builder mutateAccessorAnnotations(Consumer<? super List<Excerpt>> mutator)

Applies mutator to the list to be returned from Property.getAccessorAnnotations().

This method mutates the list in-place. mutator is a void consumer, so any value returned from a lambda will be ignored. Take care not to call pure functions, like Collection.stream().

Returns:

this Builder object

Throws:

NullPointerException - if mutator is null

clearAccessorAnnotations

public Property.Builder clearAccessorAnnotations()

Clears the list to be returned from Property.getAccessorAnnotations().

Returns:

this Builder object

getAccessorAnnotations

public List<Excerpt> getAccessorAnnotations()

Returns an unmodifiable view of the list that will be returned by Property.getAccessorAnnotations(). Changes to this builder will be reflected in the view.

addGetterAnnotations

public Property.Builder addGetterAnnotations(Excerpt element)

Adds element to the list to be returned from Property.getGetterAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if element is null

addGetterAnnotations

public Property.Builder addGetterAnnotations(Excerpt... elements)

Adds each element of elements to the list to be returned from Property.getGetterAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

addAllGetterAnnotations

public Property.Builder addAllGetterAnnotations(Spliterator<? extends Excerpt> elements)

Adds each element of elements to the list to be returned from Property.getGetterAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

addAllGetterAnnotations

public Property.Builder addAllGetterAnnotations(BaseStream<? extends Excerpt, ?> elements)

Adds each element of elements to the list to be returned from Property.getGetterAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

addAllGetterAnnotations

public Property.Builder addAllGetterAnnotations(Iterable<? extends Excerpt> elements)

Adds each element of elements to the list to be returned from Property.getGetterAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

mutateGetterAnnotations

public Property.Builder mutateGetterAnnotations(Consumer<? super List<Excerpt>> mutator)

Applies mutator to the list to be returned from Property.getGetterAnnotations().

This method mutates the list in-place. mutator is a void consumer, so any value returned from a lambda will be ignored. Take care not to call pure functions, like Collection.stream().

Returns:

this Builder object

Throws:

NullPointerException - if mutator is null

clearGetterAnnotations

public Property.Builder clearGetterAnnotations()

Clears the list to be returned from Property.getGetterAnnotations().

Returns:

this Builder object

getGetterAnnotations

public List<Excerpt> getGetterAnnotations()

Returns an unmodifiable view of the list that will be returned by Property.getGetterAnnotations(). Changes to this builder will be reflected in the view.

addPutAnnotations

public Property.Builder addPutAnnotations(Excerpt element)

Adds element to the list to be returned from Property.getPutAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if element is null

addPutAnnotations

public Property.Builder addPutAnnotations(Excerpt... elements)

Adds each element of elements to the list to be returned from Property.getPutAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

addAllPutAnnotations

public Property.Builder addAllPutAnnotations(Spliterator<? extends Excerpt> elements)

Adds each element of elements to the list to be returned from Property.getPutAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

addAllPutAnnotations

public Property.Builder addAllPutAnnotations(BaseStream<? extends Excerpt, ?> elements)

Adds each element of elements to the list to be returned from Property.getPutAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

addAllPutAnnotations

public Property.Builder addAllPutAnnotations(Iterable<? extends Excerpt> elements)

Adds each element of elements to the list to be returned from Property.getPutAnnotations().

Returns:

this Builder object

Throws:

NullPointerException - if elements is null or contains a null element

mutatePutAnnotations

public Property.Builder mutatePutAnnotations(Consumer<? super List<Excerpt>> mutator)

Applies mutator to the list to be returned from Property.getPutAnnotations().

This method mutates the list in-place. mutator is a void consumer, so any value returned from a lambda will be ignored. Take care not to call pure functions, like Collection.stream().

Returns:

this Builder object

Throws:

NullPointerException - if mutator is null

clearPutAnnotations

public Property.Builder clearPutAnnotations()

Clears the list to be returned from Property.getPutAnnotations().

Returns:

this Builder object

getPutAnnotations

public List<Excerpt> getPutAnnotations()

Returns an unmodifiable view of the list that will be returned by Property.getPutAnnotations(). Changes to this builder will be reflected in the view.

mergeFrom

public Property.Builder mergeFrom(Property value)

Copies values from value, appending to collections, and skipping defaults and empty optionals.

Returns:

this Builder object

mergeFrom

public Property.Builder mergeFrom(Property.Builder template)

Copies values from template, appending to collections, and skipping defaults, empty optionals and unset properties.

Returns:

this Builder object

clear

public Property.Builder clear()

Resets the state of this builder.

Returns:

this Builder object

build

public Property build()

Returns a newly-created Property based on the contents of this Builder.

Throws:

IllegalStateException - if any field has not been set

buildPartial

public Property buildPartial()

Returns a newly-created partial Property for use in unit tests. State checking will not be performed. Unset properties will throw an UnsupportedOperationException when accessed via the partial object.

The builder returned by from(org.inferred.freebuilder.processor.property.Property) will propagate the partial status of its input, overriding build() to return another partial. This allows for robust tests of modify-rebuild code.

Partials should only ever be used in tests. They permit writing robust test cases that won't fail if this type gains more application-level constraints (e.g. new required fields) in future. If you require partially complete values in production code, consider using a Builder.