ConfigAggregateBuilder (fiber 0.12.1-4 API)

java.lang.Object
- me.zeroeightsix.fiber.builder.ConfigValueBuilder<A>
- - me.zeroeightsix.fiber.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 ConfigValueBuilder<A>
```
A ConfigValueBuilder that produces aggregate ConfigValues.
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 ConfigValueBuilder.

See Also:

create(java.lang.String, java.lang.Class<E[]>)

Field Summary
- Fields inherited from class me.zeroeightsix.fiber.builder.ConfigValueBuilder
  constraintList, type

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AggregateConstraintsBuilder<ConfigAggregateBuilder<A,E>,A,E>`	`constraints()` Creates a constraint builder for this `ConfigValueBuilder`.
`static <C extends java.util.Collection<E>,E> ConfigAggregateBuilder<C,E>`	`create(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(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.
`ConfigAggregateBuilder<A,E>`	`setFinal()` Marks a setting as final.
`ConfigAggregateBuilder<A,E>`	`setFinal(boolean isFinal)` Sets the finality.
`ConfigAggregateBuilder<A,E>`	`withComment(java.lang.String comment)` Sets the `ConfigValue`'s comment.
`ConfigAggregateBuilder<A,E>`	`withDefaultValue(A defaultValue)` Sets the default value.
`ConfigAggregateBuilder<A,E>`	`withListener(java.util.function.BiConsumer<A,A> consumer)` Adds a listener to the `ConfigValue`.
`ConfigAggregateBuilder<A,E>`	`withName(java.lang.String name)` Sets the `ConfigValue`'s name.
`ConfigAggregateBuilder<A,E>`	`withParent(Node node)` Sets the node that the `ConfigValue` will be registered to.

Methods inherited from class me.zeroeightsix.fiber.builder.ConfigValueBuilder
build

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(@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(@Nonnull
                                                                                       java.lang.String name,
                                                                                       @Nonnull
                                                                                       java.lang.Class<? super C> collectionType,
                                                                                       @Nonnull
                                                                                       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(java.lang.String name)
```
    Description copied from class: ConfigValueBuilder
    
    Sets the ConfigValue's name.
    If null, or if this method is never called, the ConfigValue won't have a name. Thus, it might be ignored during (de)serialisation. It also won't be able to be found by name in its parent node.
    
    Overrides:
    
    withName in class ConfigValueBuilder<A>
    
    Parameters:
    
    name - the name
    
    Returns:
    
    this builder
    
    See Also:
    
    Node.lookup(java.lang.String)
  - withComment
```
public ConfigAggregateBuilder<A,E> withComment(java.lang.String comment)
```
    Description copied from class: ConfigValueBuilder
    
    Sets the ConfigValue's comment.
    If null, or if this method is never called, the ConfigValue won't have a comment. An empty comment (non null, but only consisting of whitespace) will be serialised.
    
    Overrides:
    
    withComment in class ConfigValueBuilder<A>
    
    Parameters:
    
    comment - the comment
    
    Returns:
    
    this builder
  - withListener
```
public ConfigAggregateBuilder<A,E> withListener(java.util.function.BiConsumer<A,A> consumer)
```
    Description copied from class: ConfigValueBuilder
    
    Adds a listener to the ConfigValue.
    Listeners are called when the value of a ConfigValue 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 ConfigValueBuilder<A>
    
    Parameters:
    
    consumer - the listener
    
    Returns:
    
    this builder
  - withDefaultValue
```
public ConfigAggregateBuilder<A,E> withDefaultValue(A defaultValue)
```
    Description copied from class: ConfigValueBuilder
    
    Sets the default value.
    If null, or if this method is never called, the ConfigValue will have no default value.
    
    Overrides:
    
    withDefaultValue in class ConfigValueBuilder<A>
    
    Parameters:
    
    defaultValue - the default value
    
    Returns:
    
    this builder
  - setFinal
```
public ConfigAggregateBuilder<A,E> setFinal()
```
    Description copied from class: ConfigValueBuilder
    
    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:
    
    setFinal in class ConfigValueBuilder<A>
    
    Returns:
    
    this builder
    
    See Also:
    
    ConfigValueBuilder.setFinal(boolean)
  - setFinal
```
public ConfigAggregateBuilder<A,E> setFinal(boolean isFinal)
```
    Description copied from class: ConfigValueBuilder
    
    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.
    
    Overrides:
    
    setFinal in class ConfigValueBuilder<A>
    
    Parameters:
    
    isFinal - the finality
    
    Returns:
    
    this builder
  - withParent
```
public ConfigAggregateBuilder<A,E> withParent(Node node)
```
    Description copied from class: ConfigValueBuilder
    
    Sets the node that the ConfigValue will be registered to.
    
    Overrides:
    
    withParent in class ConfigValueBuilder<A>
    
    Parameters:
    
    node - The node the ConfigValue will be registered to.
    
    Returns:
    
    The builder
  - constraints
```
public AggregateConstraintsBuilder<ConfigAggregateBuilder<A,E>,A,E> constraints()
```
    Description copied from class: ConfigValueBuilder
    
    Creates a constraint builder for this ConfigValueBuilder.
    
    Overrides:
    
    constraints in class ConfigValueBuilder<A>
    
    Returns:
    
    the created builder
    
    See Also:
    
    ConstraintsBuilder

Class ConfigAggregateBuilder<A,E>

Field Summary

Fields inherited from class me.zeroeightsix.fiber.builder.ConfigValueBuilder

Method Summary

Methods inherited from class me.zeroeightsix.fiber.builder.ConfigValueBuilder

Methods inherited from class java.lang.Object

Method Detail

isAggregate

create

create

withName

withComment

withListener

withDefaultValue

setFinal

setFinal

withParent

constraints