GuildConfigurator.Builder (ultimategdbot-api 6.0.2 API)

java.lang.Object
- com.github.alex1304.ultimategdbot.api.database.guildconfig.GuildConfigurator.Builder<D>

Enclosing class:: GuildConfigurator<D extends GuildConfigData<D>>

public static class GuildConfigurator.Builder<D extends GuildConfigData<D>>
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GuildConfigurator.Builder<D>`	`addEntry(ConfigEntryBuilder<D,?> configEntryBuilder)`	Adds a new entry to this configurator.
`GuildConfigurator<D>`	`build()`	Builds the configurator with all the attributes previously set.
`GuildConfigurator.Builder<D>`	`onSave(Consumer<? super D> onSave)`	Specifies a callback to invoke when the modified data is saved to the database.
`GuildConfigurator.Builder<D>`	`setDescription(String description)`	Specifies a user-friendly description for this configurator.

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

- Method Detail
  - setDescription
```
public GuildConfigurator.Builder<D> setDescription(@Nullable
                                                   String description)
```
    Specifies a user-friendly description for this configurator. If not set or is set to null, an empty string will be used as description.
    
    Parameters:
    
    description - the description to set
    
    Returns:
    
    this builder
  - addEntry
```
public GuildConfigurator.Builder<D> addEntry(ConfigEntryBuilder<D,?> configEntryBuilder)
```
    Adds a new entry to this configurator. The argument is a builder that will instantiate the entry once the configurator is initialized.
    
    Parameters:
    
    configEntryBuilder - a builder that generates the entry to add
    
    Returns:
    
    this builder
  - onSave
```
public GuildConfigurator.Builder<D> onSave(@Nullable
                                           Consumer<? super D> onSave)
```
    Specifies a callback to invoke when the modified data is saved to the database.
    
    Parameters:
    
    onSave - a consumer that accepts the data after modification by this configurator
    
    Returns:
    
    this builder
  - build
```
public GuildConfigurator<D> build()
```
    Builds the configurator with all the attributes previously set.
    
    Returns:
    
    a new GuildConfigurator