Interface EmbedDataSource

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface EmbedDataSource

An EmbedDataSource is used to retrieve Embeds based on a unique name from various sources.

Method Summary

Modifier and Type	Method	Description
static EmbedDataSource	dataObject(DataObject dataObject)	Constructs a new EmbedDataSource using a DataObject as its source.
static EmbedDataSource	file(Path path)	Constructs a new EmbedDataSource using a Path pointing to a JSON file as its source.
Optional<Embed>	get(String embed, Map<String,Object> placeholders, I18n i18n)	Retrieves an Embed based on the given name.
static EmbedDataSource	inputStream(InputStream inputStream)	Constructs a new EmbedDataSource using an JSON InputStream as its source.
static EmbedDataSource	json(String json)	Constructs a new EmbedDataSource using a JSON payload as its source.
static EmbedDataSource	resource(String resource)	Constructs a new EmbedDataSource using a JSON file that is located inside the resources folder.

Method Details

json

static EmbedDataSource json(String json)

Constructs a new EmbedDataSource using a JSON payload as its source.

Parameters:

json - the JSON payload to retrieve embeds from

Returns:

a new EmbedDataSource

resource

static EmbedDataSource resource(String resource)

Constructs a new EmbedDataSource using a JSON file that is located inside the resources folder.

Parameters:

resource - the Path pointing to a JSON file

Returns:

a new EmbedDataSource

file

static EmbedDataSource file(Path path)

Constructs a new EmbedDataSource using a Path pointing to a JSON file as its source.

Parameters:

path - the Path pointing to a JSON file

Returns:

a new EmbedDataSource

inputStream

static EmbedDataSource inputStream(InputStream inputStream)

Constructs a new EmbedDataSource using an JSON InputStream as its source.

Parameters:

inputStream - the InputStream to retrieve embeds from

Returns:

a new EmbedDataSource

dataObject

static EmbedDataSource dataObject(DataObject dataObject)

Constructs a new EmbedDataSource using a DataObject as its source.

Parameters:

dataObject - the DataObject to retrieve embeds from

Returns:

a new EmbedDataSource

get

Optional<Embed> get(String embed,
 Map<String,Object> placeholders,
 I18n i18n)

Retrieves an Embed based on the given name.

Parameters:

embed - the name of the embed to retrieve

placeholders - a Map of placeholders to use

i18n - the I18n instance to use

Returns:

an Optional holding the Embed constructed from the retrieved embed json or an empty Optional if no embed was found for the given name

Throws:

ParsingException - If the embed json is incorrect