Property.Builder (FreeBuilder 2.1.1 API)

java.lang.Object
- org.inferred.freebuilder.processor.Property.Builder

Enclosing class:: Property

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

Builder for Property.

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Property.Builder`	`addAccessorAnnotations(Excerpt... elements)` Adds each element of `elements` to the list to be returned from `Property.getAccessorAnnotations()`.
`Property.Builder`	`addAccessorAnnotations(Excerpt element)` Adds `element` to the list to be returned from `Property.getAccessorAnnotations()`.
`Property.Builder`	`addAllAccessorAnnotations(java.util.stream.BaseStream<? extends Excerpt,?> elements)` Adds each element of `elements` to the list to be returned from `Property.getAccessorAnnotations()`.
`Property.Builder`	`addAllAccessorAnnotations(java.lang.Iterable<? extends Excerpt> elements)` Adds each element of `elements` to the list to be returned from `Property.getAccessorAnnotations()`.
`Property.Builder`	`addAllAccessorAnnotations(java.util.Spliterator<? extends Excerpt> elements)` Adds each element of `elements` to the list to be returned from `Property.getAccessorAnnotations()`.
`Property`	`build()` Returns a newly-created `Property` based on the contents of the `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()`.
`static Property.Builder`	`from(Property value)` Creates a new builder using `value` as a template.
`java.util.List<Excerpt>`	`getAccessorAnnotations()` Returns an unmodifiable view of the list that will be returned by `Property.getAccessorAnnotations()`.
`java.lang.String`	`getAllCapsName()` Returns the value that will be returned by `Property.getAllCapsName()`.
`java.util.Optional<javax.lang.model.type.TypeMirror>`	`getBoxedType()` Returns the value that will be returned by `Property.getBoxedType()`.
`java.lang.String`	`getCapitalizedName()` Returns the value that will be returned by `Property.getCapitalizedName()`.
`java.lang.String`	`getGetterName()` Returns the value that will be returned by `Property.getGetterName()`.
`java.lang.String`	`getName()` Returns the value that will be returned by `Property.getName()`.
`javax.lang.model.type.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`	`isUsingBeanConvention()` Returns the value that will be returned by `Property.isUsingBeanConvention()`.
`Property.Builder`	`mapAllCapsName(java.util.function.UnaryOperator<java.lang.String> mapper)` Replaces the value to be returned by `Property.getAllCapsName()` by applying `mapper` to it and using the result.
`Property.Builder`	`mapBoxedType(java.util.function.UnaryOperator<javax.lang.model.type.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(java.util.function.UnaryOperator<java.lang.String> mapper)` Replaces the value to be returned by `Property.getCapitalizedName()` by applying `mapper` to it and using the result.
`Property.Builder`	`mapFullyCheckedCast(java.util.function.UnaryOperator<java.lang.Boolean> mapper)` Replaces the value to be returned by `Property.isFullyCheckedCast()` by applying `mapper` to it and using the result.
`Property.Builder`	`mapGetterName(java.util.function.UnaryOperator<java.lang.String> mapper)` Replaces the value to be returned by `Property.getGetterName()` by applying `mapper` to it and using the result.
`Property.Builder`	`mapName(java.util.function.UnaryOperator<java.lang.String> mapper)` Replaces the value to be returned by `Property.getName()` by applying `mapper` to it and using the result.
`Property.Builder`	`mapType(java.util.function.UnaryOperator<javax.lang.model.type.TypeMirror> mapper)` Replaces the value to be returned by `Property.getType()` by applying `mapper` to it and using the result.
`Property.Builder`	`mapUsingBeanConvention(java.util.function.UnaryOperator<java.lang.Boolean> mapper)` Replaces the value to be returned by `Property.isUsingBeanConvention()` by applying `mapper` to it and using the result.
`Property.Builder`	`mergeFrom(Property.Builder template)` Copies values from the given `Builder`.
`Property.Builder`	`mergeFrom(Property value)` Sets all property values using the given `org.inferred.freebuilder.processor.Property` as a template.
`Property.Builder`	`mutateAccessorAnnotations(java.util.function.Consumer<? super java.util.List<Excerpt>> mutator)` Applies `mutator` to the list to be returned from `Property.getAccessorAnnotations()`.
`Property.Builder`	`setAllCapsName(java.lang.String allCapsName)` Sets the value to be returned by `Property.getAllCapsName()`.
`Property.Builder`	`setBoxedType(java.util.Optional<? extends javax.lang.model.type.TypeMirror> boxedType)` Sets the value to be returned by `Property.getBoxedType()`.
`Property.Builder`	`setBoxedType(javax.lang.model.type.TypeMirror boxedType)` Sets the value to be returned by `Property.getBoxedType()`.
`Property.Builder`	`setCapitalizedName(java.lang.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(java.lang.String getterName)` Sets the value to be returned by `Property.getGetterName()`.
`Property.Builder`	`setName(java.lang.String name)` Sets the value to be returned by `Property.getName()`.
`Property.Builder`	`setNullableBoxedType(javax.lang.model.type.TypeMirror boxedType)` Sets the value to be returned by `Property.getBoxedType()`.
`Property.Builder`	`setType(javax.lang.model.type.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - from
```
public static Property.Builder from(Property value)
```
    Creates a new builder using value as a template.
  - setType
```
public Property.Builder setType(javax.lang.model.type.TypeMirror type)
```
    Sets the value to be returned by Property.getType().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    java.lang.NullPointerException - if type is null
  - mapType
```
public Property.Builder mapType(java.util.function.UnaryOperator<javax.lang.model.type.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:
    
    java.lang.NullPointerException - if mapper is null or returns null
    
    java.lang.IllegalStateException - if the field has not been set
  - getType
```
public javax.lang.model.type.TypeMirror getType()
```
    Returns the value that will be returned by Property.getType().
    
    Throws:
    
    java.lang.IllegalStateException - if the field has not been set
  - setBoxedType
```
public Property.Builder setBoxedType(javax.lang.model.type.TypeMirror boxedType)
```
    Sets the value to be returned by Property.getBoxedType().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    java.lang.NullPointerException - if boxedType is null
  - setBoxedType
```
public Property.Builder setBoxedType(java.util.Optional<? extends javax.lang.model.type.TypeMirror> boxedType)
```
    Sets the value to be returned by Property.getBoxedType().
    
    Returns:
    
    this Builder object
  - setNullableBoxedType
```
public Property.Builder setNullableBoxedType(javax.lang.model.type.TypeMirror boxedType)
```
    Sets the value to be returned by Property.getBoxedType().
    
    Returns:
    
    this Builder object
  - mapBoxedType
```
public Property.Builder mapBoxedType(java.util.function.UnaryOperator<javax.lang.model.type.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:
    
    java.lang.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 java.util.Optional<javax.lang.model.type.TypeMirror> getBoxedType()
```
    Returns the value that will be returned by Property.getBoxedType().
  - setName
```
public Property.Builder setName(java.lang.String name)
```
    Sets the value to be returned by Property.getName().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    java.lang.NullPointerException - if name is null
  - mapName
```
public Property.Builder mapName(java.util.function.UnaryOperator<java.lang.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:
    
    java.lang.NullPointerException - if mapper is null or returns null
    
    java.lang.IllegalStateException - if the field has not been set
  - getName
```
public java.lang.String getName()
```
    Returns the value that will be returned by Property.getName().
    
    Throws:
    
    java.lang.IllegalStateException - if the field has not been set
  - setCapitalizedName
```
public Property.Builder setCapitalizedName(java.lang.String capitalizedName)
```
    Sets the value to be returned by Property.getCapitalizedName().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    java.lang.NullPointerException - if capitalizedName is null
  - mapCapitalizedName
```
public Property.Builder mapCapitalizedName(java.util.function.UnaryOperator<java.lang.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:
    
    java.lang.NullPointerException - if mapper is null or returns null
    
    java.lang.IllegalStateException - if the field has not been set
  - getCapitalizedName
```
public java.lang.String getCapitalizedName()
```
    Returns the value that will be returned by Property.getCapitalizedName().
    
    Throws:
    
    java.lang.IllegalStateException - if the field has not been set
  - setAllCapsName
```
public Property.Builder setAllCapsName(java.lang.String allCapsName)
```
    Sets the value to be returned by Property.getAllCapsName().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    java.lang.NullPointerException - if allCapsName is null
  - mapAllCapsName
```
public Property.Builder mapAllCapsName(java.util.function.UnaryOperator<java.lang.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:
    
    java.lang.NullPointerException - if mapper is null or returns null
    
    java.lang.IllegalStateException - if the field has not been set
  - getAllCapsName
```
public java.lang.String getAllCapsName()
```
    Returns the value that will be returned by Property.getAllCapsName().
    
    Throws:
    
    java.lang.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(java.util.function.UnaryOperator<java.lang.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:
    
    java.lang.NullPointerException - if mapper is null or returns null
    
    java.lang.IllegalStateException - if the field has not been set
  - isUsingBeanConvention
```
public boolean isUsingBeanConvention()
```
    Returns the value that will be returned by Property.isUsingBeanConvention().
    
    Throws:
    
    java.lang.IllegalStateException - if the field has not been set
  - setGetterName
```
public Property.Builder setGetterName(java.lang.String getterName)
```
    Sets the value to be returned by Property.getGetterName().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    java.lang.NullPointerException - if getterName is null
  - mapGetterName
```
public Property.Builder mapGetterName(java.util.function.UnaryOperator<java.lang.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:
    
    java.lang.NullPointerException - if mapper is null or returns null
    
    java.lang.IllegalStateException - if the field has not been set
  - getGetterName
```
public java.lang.String getGetterName()
```
    Returns the value that will be returned by Property.getGetterName().
    
    Throws:
    
    java.lang.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(java.util.function.UnaryOperator<java.lang.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:
    
    java.lang.NullPointerException - if mapper is null or returns null
    
    java.lang.IllegalStateException - if the field has not been set
  - isFullyCheckedCast
```
public boolean isFullyCheckedCast()
```
    Returns the value that will be returned by Property.isFullyCheckedCast().
    
    Throws:
    
    java.lang.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:
    
    java.lang.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:
    
    java.lang.NullPointerException - if elements is null or contains a null element
  - addAllAccessorAnnotations
```
public Property.Builder addAllAccessorAnnotations(java.util.Spliterator<? extends Excerpt> elements)
```
    Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    java.lang.NullPointerException - if elements is null or contains a null element
  - addAllAccessorAnnotations
```
public Property.Builder addAllAccessorAnnotations(java.util.stream.BaseStream<? extends Excerpt,?> elements)
```
    Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    java.lang.NullPointerException - if elements is null or contains a null element
  - addAllAccessorAnnotations
```
public Property.Builder addAllAccessorAnnotations(java.lang.Iterable<? extends Excerpt> elements)
```
    Adds each element of elements to the list to be returned from Property.getAccessorAnnotations().
    
    Returns:
    
    this Builder object
    
    Throws:
    
    java.lang.NullPointerException - if elements is null or contains a null element
  - mutateAccessorAnnotations
```
public Property.Builder mutateAccessorAnnotations(java.util.function.Consumer<? super java.util.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:
    
    java.lang.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 java.util.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.
  - mergeFrom
```
public Property.Builder mergeFrom(Property value)
```
    Sets all property values using the given org.inferred.freebuilder.processor.Property as a template.
  - mergeFrom
```
public Property.Builder mergeFrom(Property.Builder template)
```
    Copies values from the given Builder. Does not affect any properties not set on the input.
  - clear
```
public Property.Builder clear()
```
    Resets the state of this builder.
  - build
```
public Property build()
```
    Returns a newly-created Property based on the contents of the Builder.
    
    Throws:
    
    java.lang.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.
    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.

Class Property.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

from

setType

mapType

getType

setBoxedType

setBoxedType

setNullableBoxedType

mapBoxedType

clearBoxedType

getBoxedType

setName

mapName

getName

setCapitalizedName

mapCapitalizedName

getCapitalizedName

setAllCapsName

mapAllCapsName

getAllCapsName

setUsingBeanConvention

mapUsingBeanConvention

isUsingBeanConvention

setGetterName

mapGetterName

getGetterName

setFullyCheckedCast

mapFullyCheckedCast

isFullyCheckedCast

addAccessorAnnotations

addAccessorAnnotations

addAllAccessorAnnotations

addAllAccessorAnnotations

addAllAccessorAnnotations

mutateAccessorAnnotations

clearAccessorAnnotations

getAccessorAnnotations

mergeFrom

mergeFrom

clear

build

buildPartial