Class Embeds.Configuration

java.lang.Object

io.github.kaktushose.jdac.embeds.internal.Embeds.Configuration

All Implemented Interfaces:

EmbedConfig

Enclosing class:

Embeds

public static class Embeds.Configuration
extends Object
implements EmbedConfig

Constructor Summary

Constructors

Constructor	Description
Configuration(MessageResolver messageResolver)	Constructs a new embed configuration builder.

Method Summary

Modifier and Type	Method	Description
Embeds	buildDefault()	Converts this configuration into an Embeds instance that should be used globally.
Embeds	buildError()	Converts this configuration into an Embeds instance that should only be used by DefaultErrorMessageFactory.
Embeds.Configuration	errorSource(EmbedDataSource source)	Adds a new EmbedDataSource that will be used by the DefaultErrorMessageFactory to load the error messages from.
Embeds.Configuration	placeholders(Entry... placeholders)	Adds one or more new global placeholders.
Embeds.Configuration	placeholders(Map<String,Object> placeholders)	Adds global placeholders with the values of the given map, where the key of the map represents the name of the placeholder and the value of the map the value to replace the placeholder with.
Embeds.Configuration	sources(EmbedDataSource... source)	Adds a new EmbedDataSource that Embeds can be loaded from.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Configuration

public Configuration(MessageResolver messageResolver)

Constructs a new embed configuration builder.

Method Details

placeholders

public Embeds.Configuration placeholders(Entry... placeholders)

Description copied from interface: EmbedConfig

Adds one or more new global placeholders. Global placeholders will be available for any Embed loaded by this API.

Specified by:

placeholders in interface EmbedConfig

Parameters:

placeholders - the entries to add

Returns:

this instance for fluent interface

placeholders

public Embeds.Configuration placeholders(Map<String,Object> placeholders)

Description copied from interface: EmbedConfig

Adds global placeholders with the values of the given map, where the key of the map represents the name of the placeholder and the value of the map the value to replace the placeholder with.

Global placeholders will be available for any Embed loaded by this API.

Specified by:

placeholders in interface EmbedConfig

Parameters:

placeholders - the Map to get the values from

Returns:

this instance for fluent interface

sources

public Embeds.Configuration sources(EmbedDataSource... source)

Description copied from interface: EmbedConfig

Adds a new EmbedDataSource that Embeds can be loaded from.

Specified by:

sources in interface EmbedConfig

Parameters:

source - the EmbedDataSource to add

Returns:

this instance for fluent interface

errorSource

public Embeds.Configuration errorSource(EmbedDataSource source)

Description copied from interface: EmbedConfig

Adds a new EmbedDataSource that will be used by the DefaultErrorMessageFactory to load the error messages from.

Specified by:

errorSource in interface EmbedConfig

Parameters:

source - the EmbedDataSource to load the error embeds from

Returns:

this instance for fluent interface

buildDefault

public Embeds buildDefault()

Converts this configuration into an Embeds instance that should be used globally.

Returns:

an Embeds instance for default usage

buildError

public Embeds buildError()

Converts this configuration into an Embeds instance that should only be used by DefaultErrorMessageFactory.

Returns:

an Embeds instance for usage inside DefaultErrorMessageFactory