Interface DocumentGenerator<T>

Type Parameters:

T - type of the entity used to create the document

public interface DocumentGenerator<T>

The generator is responsible for creating a document from an entity and a set of properties. The properties are used to configure the generation process. The configuration can also be defined in the constructor of the generator.

The generator instance can be discarded after the generation of the document.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COPYRIGHT_KEY
static final String	LOGO_PATH_KEY
static final String	ORGANIZATION_DATE_FORMAT_KEY
static final String	ORGANIZATION_ID_KEY
static final String	ORGANIZATION_LANGUAGE_KEY
static final String	ORGANIZATION_NAME_KEY
static final String	THEME_PATH_KEY

Method Summary

Modifier and Type	Method	Description
void	export(T entity, boolean overwrite, @NonNull Path document, @NotNull DomainAudit audit)	Creates a new output document.
default boolean	shouldExport(@NonNull Path document, boolean overwrite)

Field Details

ORGANIZATION_NAME_KEY

static final String ORGANIZATION_NAME_KEY

See Also:

• Constant Field Values

ORGANIZATION_ID_KEY

static final String ORGANIZATION_ID_KEY

See Also:

• Constant Field Values

ORGANIZATION_LANGUAGE_KEY

static final String ORGANIZATION_LANGUAGE_KEY

See Also:

• Constant Field Values

ORGANIZATION_DATE_FORMAT_KEY

static final String ORGANIZATION_DATE_FORMAT_KEY

See Also:

• Constant Field Values

COPYRIGHT_KEY

static final String COPYRIGHT_KEY

See Also:

• Constant Field Values

THEME_PATH_KEY

static final String THEME_PATH_KEY

See Also:

• Constant Field Values

LOGO_PATH_KEY

static final String LOGO_PATH_KEY

See Also:

• Constant Field Values

Method Details

export

void export(@NotNull
 T entity,
 boolean overwrite,
 @NonNull
 @NonNull Path document,
 @NotNull
 @NotNull DomainAudit audit)

Creates a new output document.

Parameters:

entity - entity used to create a new invoice document

audit - domain audit sink to log the operation events

shouldExport

default boolean shouldExport(@NonNull
 @NonNull Path document,
 boolean overwrite)