java.lang.Object
- io.github.mmm.property.builder.PropertyBuilder<V,P,B,SELF>

Type Parameters:

V - type of the property value.

P - type of the Property to build.

B - type of the validator builder for withValidator().

SELF - type of this PropertyBuilder itself.

Direct Known Subclasses:

BooleanPropertyBuilder, ComparablePropertyBuilder, ListPropertyBuilder, MapPropertyBuilder, PatternPropertyBuilder, RangePropertyBuilder, SetPropertyBuilder
```
public abstract class PropertyBuilder<V,P extends Property<V>,B extends io.github.mmm.validation.main.ObjectValidatorBuilder<V,? extends PropertyBuilder<V,P,B,SELF>,?>,SELF extends PropertyBuilder<V,P,B,SELF>>
extends Object
```
Abstract base class for a Builder to create instances of a particular type of Property.
As a Property typically has only one single required parameter that is also the most specific parameter, it is provided to the build-method. Therefore ProcessBuilder does not implement Builder and does not follow the default builder-pattern providing a non-arg build() method.
For a specific Property type the builder should carry the same name with the suffix Builder. Example: BooleanProperty is build by BooleanPropertyBuilder.

Since:

1.0.0

Field Summary

Fields
Modifier and Type Field Description

protected Supplier<? extends V> expression

protected AttributeReadOnly lock

protected V value

Constructor Summary

Constructors
Constructor Description

PropertyBuilder(AttributeReadOnly lock)
The constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`ListPropertyBuilder<V>`	`asList()`
`MapPropertyBuilder<String,V>`	`asMap()`
`<K> MapPropertyBuilder<K,V>`	`asMap(SimpleProperty<K> keyProperty)`
`SetPropertyBuilder<V>`	`asSet()`
`P`	`build(String name)`
`protected P`	`build(String name, boolean ignoreExtensions)`
`protected abstract P`	`build(String name, PropertyMetadata<V> newMetadata)`
`protected <T extends PropertyBuilder<?,?,?,?>> T`	`builder(T builder)`
`protected abstract B`	`createValidatorBuilder()`
`SELF`	`factory(Function<String,P> function)`
`AttributeReadOnly`	`getLock()`
`SELF`	`metadata(String metadataKey, Object metadataValue)`
`SELF`	`registry(Consumer<? super P> consumer)`
`protected SELF`	`self()`
`SELF`	`value(V initialValue)`
`SELF`	`valueExpression(Supplier<? extends V> propertyValueExpression)`
`B`	`withValidator()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - lock
```
protected final AttributeReadOnly lock
```
    See Also:
    
    getLock()
  - expression
```
protected Supplier<? extends V> expression
```
    See Also:
    
    valueExpression(Supplier)
  - value
```
protected V value
```
    See Also:
    
    value(Object)
- Constructor Detail
  - PropertyBuilder
```
public PropertyBuilder(AttributeReadOnly lock)
```
    The constructor.
    
    Parameters:
    
    lock - the lock.
- Method Detail
  - self
```
protected SELF self()
```
    Returns:
    
    this object itself (this) for fluent API calls.
  - getLock
```
public AttributeReadOnly getLock()
```
    Returns:
    
    the lock.
  - registry
```
public SELF registry(Consumer<? super P> consumer)
```
    Parameters:
    
    consumer - the Consumer receiving the Property when build.
    
    Returns:
    
    this builder itself (this) for fluent API calls.
  - factory
```
public SELF factory(Function<String,P> function)
```
    Parameters:
    
    function - the Function optionally providing the Property to build. If it returns a result other than null this will be used instead and the actual building is entirely replaced. This is a very specific feature provided for internal usage (to receive read-only view of already existing property).
    
    Returns:
    
    this builder itself (this) for fluent API calls.
  - valueExpression
```
public SELF valueExpression(Supplier<? extends V> propertyValueExpression)
```
    Parameters:
    
    propertyValueExpression - the property value expression.
    
    Returns:
    
    this builder itself (this) for fluent API calls.
  - value
```
public SELF value(V initialValue)
```
    Parameters:
    
    initialValue - the initial value of the Property to build.
    
    Returns:
    
    this builder itself (this) for fluent API calls.
  - metadata
```
public SELF metadata(String metadataKey,
                     Object metadataValue)
```
    Parameters:
    
    metadataKey - the metadata key.
    
    metadataValue - the metadata value.
    
    Returns:
    
    this builder itself (this) for fluent API calls.
  - createValidatorBuilder
```
protected abstract B createValidatorBuilder()
```
    Returns:
    
    the ObjectValidatorBuilder corresponding to this type of builder.
  - withValidator
```
public B withValidator()
```
    Returns:
    
    a sub-builder for the validator of the Property to build. Use the and() method to return from the sub-builder to this property builder when the validator is configured.
  - build
```
public final P build(String name)
```
    Parameters:
    
    name - the property name of the Property to build.
    
    Returns:
    
    the Property to build.
  - build
```
protected final P build(String name,
                        boolean ignoreExtensions)
```
    Parameters:
    
    name - the property name of the Property to build.
    
    ignoreExtensions - - true to ignore a potential registry(Consumer) and factory(Function), false otherwise.
    
    Returns:
    
    the Property to build.
  - build
```
protected abstract P build(String name,
                           PropertyMetadata<V> newMetadata)
```
    Parameters:
    
    name - the property name of the Property to build.
    
    newMetadata - the PropertyMetadata.
    
    Returns:
    
    the Property to build.
  - asList
```
public ListPropertyBuilder<V> asList()
```
    Returns:
    
    a ListPropertyBuilder using this property configuration for its elements.
  - asSet
```
public SetPropertyBuilder<V> asSet()
```
    Returns:
    
    a SetPropertyBuilder using this property configuration for its elements.
  - asMap
```
public MapPropertyBuilder<String,V> asMap()
```
    Returns:
    
    a MapPropertyBuilder using this property configuration for its values and String as keys.
  - builder
```
protected <T extends PropertyBuilder<?,?,?,?>> T builder(T builder)
```
    Type Parameters:
    
    T - type of the PropertyBuilder.
    
    Parameters:
    
    builder - the PropertyBuilder.
    
    Returns:
    
    the configured builder.
  - asMap
```
public <K> MapPropertyBuilder<K,V> asMap(SimpleProperty<K> keyProperty)
```
    Type Parameters:
    
    K - type of the keys.
    
    Parameters:
    
    keyProperty - the key property.
    
    Returns:
    
    a MapPropertyBuilder using this property configuration for its values and String as keys.

Modifier and Type	Field	Description
`protected Supplier<? extends V>`	`expression`
`protected AttributeReadOnly`	`lock`
`protected V`	`value`

Class PropertyBuilder<V,​P extends Property<V>,​B extends io.github.mmm.validation.main.ObjectValidatorBuilder<V,​? extends PropertyBuilder<V,​P,​B,​SELF>,​?>,​SELF extends PropertyBuilder<V,​P,​B,​SELF>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lock

expression

value

Constructor Detail

PropertyBuilder

Method Detail

self

getLock

registry

factory

valueExpression

value

metadata

createValidatorBuilder

withValidator

build

build

build

asList

asSet

asMap

builder

asMap

Class PropertyBuilder<V,P extends Property<V>,B extends io.github.mmm.validation.main.ObjectValidatorBuilder<V,? extends PropertyBuilder<V,P,B,SELF>,?>,SELF extends PropertyBuilder<V,P,B,SELF>>