de.galan.dmsexchange.exchange

Interface DmsWriter

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

ConditionalDmsWriter

All Known Implementing Classes:

DefaultConditionalDmsWriter, DefaultDmsWriter

public interface DmsWriter
extends AutoCloseable

Creation of the export-archive as well as adding Documents (container) to it. Working with a DmsWriter Implementation consists of the following steps:

• Create the desired implementation, preferably using the DmsExchange factory methods
• Adding Documents thru the add(..) or addQuietly(..) methods
• Closing the Writer using close()
• If the file hasn't been passed directly, or the export-archive consists of multiple files, you receive the created export-archives using the getFiles() method

Author:

daniel

Method Summary

Modifier and Type	Method and Description
default void	add(Document... documents) Validates and adds documents to the export-archive.
void	add(Document document) Validates and adds a Document to the export-archive.
default void	add(List<Document> documents) Validates and adds documents to the export-archive.
default void	addQuietly(Document... documents) Validates and adds documents to the export-archive.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

add

default void add(Document... documents)
          throws DmsExchangeException

Validates and adds documents to the export-archive. Will abort on the first invalid document, an alternative is using addQuiet(..) which swallows the Exceptions.

Parameters:

documents - The documents to add, fails on the first erroneous Document

Throws:

DmsExchangeException - Encapsulating parent Exception for erroneous behaviour

add

default void add(List<Document> documents)
          throws DmsExchangeException

Validates and adds documents to the export-archive. Will abort on the first invalid document, an alternative is using addQuiet(..) which swallows the Exceptions.

Parameters:

documents - The documents to add, fails on the first erroneous Document

Throws:

DmsExchangeException - Encapsulating parent Exception for erroneous behaviour

addQuietly

default void addQuietly(Document... documents)

Validates and adds documents to the export-archive. Will swallow quietly the DmsExchangeExceptions

Parameters:

documents - Documents to add, does not fail if a Document is erroneous.

add

void add(Document document)
  throws DmsExchangeException

Validates and adds a Document to the export-archive.

Throws:

DmsExchangeException - Encapsulating parent Exception for erroneous behaviour