ConfigAggregateBuilder (fiber 0.18.0-2 API)

java.lang.Object
- me.zeroeightsix.fiber.impl.builder.ConfigNodeBuilder
- - me.zeroeightsix.fiber.api.builder.ConfigLeafBuilder<A>
  - - me.zeroeightsix.fiber.api.builder.ConfigAggregateBuilder<A,E>

Type Parameters:

A - the type of aggregate value

E - the type of values held by <A>
```
public final class ConfigAggregateBuilder<A,E>
extends ConfigLeafBuilder<A>
```
A ConfigLeafBuilder that produces aggregate ConfigLeafs.
Aggregate types are those that hold multiple values, such as List or arrays. Settings with scalar types, such as Integer or String, are created using ConfigLeafBuilder.

See Also:

create(me.zeroeightsix.fiber.api.builder.ConfigTreeBuilder, java.lang.String, java.lang.Class<E[]>)

Field Summary
- Fields inherited from class me.zeroeightsix.fiber.api.builder.ConfigLeafBuilder
  constraintList, type
- Fields inherited from class me.zeroeightsix.fiber.impl.builder.ConfigNodeBuilder
  attributes, comment, name, parent

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AggregateConstraintsBuilder<A,E>`	`beginConstraints()` Creates a constraint builder for this `ConfigLeafBuilder`.
`static <C extends java.util.Collection<E>,E> ConfigAggregateBuilder<C,E>`	`create(ConfigTreeBuilder source, java.lang.String name, java.lang.Class<? super C> collectionType, java.lang.Class<E> componentType)` Creates and returns an `aggregate builder` for a collection type.
`static <E> ConfigAggregateBuilder<E[],E>`	`create(ConfigTreeBuilder source, java.lang.String name, java.lang.Class<E[]> arrayType)` Creates and returns an `aggregate builder` for an array type.
`static boolean`	`isAggregate(java.lang.Class<?> type)` Determines if a `Class` object represents an aggregate type, ie.
`<A1> ConfigAggregateBuilder<A,E>`	`withAttribute(FiberId id, java.lang.Class<A1> type, A1 defaultValue)` Adds a `ConfigAttribute` to the built `ConfigLeaf`.
`ConfigAggregateBuilder<A,E>`	`withComment(java.lang.String comment)` Sets the `ConfigLeaf`'s comment.
`ConfigAggregateBuilder<A,E>`	`withDefaultValue(A defaultValue)` Sets the default value.
`ConfigAggregateBuilder<A,E>`	`withFinality()` Marks a setting as final.
`ConfigAggregateBuilder<A,E>`	`withFinality(boolean isFinal)` Sets the finality.
`ConfigAggregateBuilder<A,E>`	`withListener(java.util.function.BiConsumer<A,A> consumer)` Adds a listener to the `ConfigLeaf`.
`ConfigAggregateBuilder<A,E>`	`withName(java.lang.String name)` Sets the `ConfigLeaf`'s name.

Methods inherited from class me.zeroeightsix.fiber.api.builder.ConfigLeafBuilder
build, finishValue, finishValue, getType

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

- Method Detail
  - isAggregate
```
public static boolean isAggregate(java.lang.Class<?> type)
```
    Determines if a Class object represents an aggregate type, ie. if it is an Array or a Collection.
    
    Parameters:
    
    type - the type to check
    
    Returns:
    
    true if type is an aggregate type; false otherwise
  - create
```
public static <E> ConfigAggregateBuilder<E[],E> create(ConfigTreeBuilder source,
                                                       @Nonnull
                                                       java.lang.String name,
                                                       @Nonnull
                                                       java.lang.Class<E[]> arrayType)
```
    Creates and returns an aggregate builder for an array type.
    
    Type Parameters:
    
    E - the type of values held by arrayType
    
    Parameters:
    
    arrayType - the class of the array used for this aggregate builder
    
    Returns:
    
    the newly created builder
    
    See Also:
    
    isAggregate(java.lang.Class<?>)
  - create
```
public static <C extends java.util.Collection<E>,E> ConfigAggregateBuilder<C,E> create(ConfigTreeBuilder source,
                                                                                       @Nonnull
                                                                                       java.lang.String name,
                                                                                       @Nonnull
                                                                                       java.lang.Class<? super C> collectionType,
                                                                                       @Nullable
                                                                                       java.lang.Class<E> componentType)
```
    Creates and returns an aggregate builder for a collection type.
    
    Type Parameters:
    
    C - the type collectionType represents. eg. List
    
    E - the type componentType represents. eg. Integer
    
    Parameters:
    
    collectionType - the class of the collection used for this aggregate builder
    
    componentType - the class of the type of elements collectionType holds
    
    Returns:
    
    the newly created builder
  - withName
```
public ConfigAggregateBuilder<A,E> withName(@Nonnull
                                            java.lang.String name)
```
    Description copied from class: ConfigLeafBuilder
    
    Sets the ConfigLeaf's name.
    
    Overrides:
    
    withName in class ConfigLeafBuilder<A>
    
    Parameters:
    
    name - the name
    
    Returns:
    
    this builder
    
    See Also:
    
    ConfigTree.lookup(java.lang.String)
  - withComment
```
public ConfigAggregateBuilder<A,E> withComment(java.lang.String comment)
```
    Description copied from class: ConfigLeafBuilder
    
    Sets the ConfigLeaf's comment.
    If null, or if this method is never called, the ConfigLeaf won't have a comment. An empty comment (non null, but only consisting of whitespace) will be serialised.
    
    Overrides:
    
    withComment in class ConfigLeafBuilder<A>
    
    Parameters:
    
    comment - the comment
    
    Returns:
    
    this builder
  - withAttribute
```
public <A1> ConfigAggregateBuilder<A,E> withAttribute(FiberId id,
                                                      java.lang.Class<A1> type,
                                                      A1 defaultValue)
```
    Description copied from class: ConfigLeafBuilder
    
    Adds a ConfigAttribute to the built ConfigLeaf.
    
    Overrides:
    
    withAttribute in class ConfigLeafBuilder<A>
    
    Type Parameters:
    
    A1 - the type of values stored in the attribute
    
    Parameters:
    
    id - the id of the attribute
    
    type - the class object representing the type of values stored in the attribute
    
    defaultValue - the attribute's default value
    
    Returns:
    
    this, for chaining
    
    See Also:
    
    ConfigNode.getAttributes()
  - withListener
```
public ConfigAggregateBuilder<A,E> withListener(java.util.function.BiConsumer<A,A> consumer)
```
    Description copied from class: ConfigLeafBuilder
    
    Adds a listener to the ConfigLeaf.
    Listeners are called when the value of a ConfigLeaf is changed. They are of type BiConsumer: the first argument being the old value, and the second argument being the new value.
    Listeners set with this method are chained: if there was already one specified, a new listener is created that calls the old one first, and then the new one.
    
    Overrides:
    
    withListener in class ConfigLeafBuilder<A>
    
    Parameters:
    
    consumer - the listener
    
    Returns:
    
    this builder
  - withDefaultValue
```
public ConfigAggregateBuilder<A,E> withDefaultValue(A defaultValue)
```
    Description copied from class: ConfigLeafBuilder
    
    Sets the default value.
    If null, or if this method is never called, the ConfigLeaf will have no default value.
    Note that every ConfigLeaf created from this builder will share a reference to the given defaultValue. Immutability is encouraged.
    
    Overrides:
    
    withDefaultValue in class ConfigLeafBuilder<A>
    
    Parameters:
    
    defaultValue - the default value
    
    Returns:
    
    this builder
  - withFinality
```
public ConfigAggregateBuilder<A,E> withFinality()
```
    Description copied from class: ConfigLeafBuilder
    
    Marks a setting as final.
    As a result of this method, any attempt to update the value of the resulting setting will fail. This method behaves as if: this.setFinal(true).
    
    Overrides:
    
    withFinality in class ConfigLeafBuilder<A>
    
    Returns:
    
    this builder
    
    See Also:
    
    ConfigLeafBuilder.withFinality(boolean)
  - withFinality
```
public ConfigAggregateBuilder<A,E> withFinality(boolean isFinal)
```
    Description copied from class: ConfigLeafBuilder
    
    Sets the finality.
    If true, the produced setting can not be changed. It will be initialised with its default value, if there is one. Afterwards, it can not be changed again; ConfigLeaf.setValue(Object) will always return false.
    
    Overrides:
    
    withFinality in class ConfigLeafBuilder<A>
    
    Parameters:
    
    isFinal - whether or not the value can be changed after building
    
    Returns:
    
    this builder
  - beginConstraints
```
public AggregateConstraintsBuilder<A,E> beginConstraints()
```
    Description copied from class: ConfigLeafBuilder
    
    Creates a constraint builder for this ConfigLeafBuilder.
    
    Overrides:
    
    beginConstraints in class ConfigLeafBuilder<A>
    
    Returns:
    
    the created builder
    
    See Also:
    
    ConstraintsBuilder

Class ConfigAggregateBuilder<A,E>

Field Summary

Fields inherited from class me.zeroeightsix.fiber.api.builder.ConfigLeafBuilder

Fields inherited from class me.zeroeightsix.fiber.impl.builder.ConfigNodeBuilder

Method Summary

Methods inherited from class me.zeroeightsix.fiber.api.builder.ConfigLeafBuilder

Methods inherited from class java.lang.Object

Method Detail

isAggregate

create

create

withName

withComment

withAttribute

withListener

withDefaultValue

withFinality

withFinality

beginConstraints