hr.ngs.templater

Interface DocumentFactory

public interface DocumentFactory

Creates template document interface

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentFactory.CancellationToken Cancel Templater processing.

Method Summary

Modifier and Type	Method and Description
default TemplateDocument	open(java.io.InputStream input, java.lang.String extension, java.io.OutputStream output) Opens a document from the specified stream.
TemplateDocument	open(java.io.InputStream input, java.lang.String extension, java.io.OutputStream output, DocumentFactory.CancellationToken cancellationToken) Opens a document from the specified stream.
TemplateDocument	open(java.lang.String path) Templater will recognize the appropriate document format from the file extension.

Method Detail

open

TemplateDocument open(java.lang.String path)
               throws java.io.IOException

Templater will recognize the appropriate document format from the file extension.

Parameters:

path - path to template document file. This file will be overwritten with the processed document.

Returns:

template document interface

Throws:

java.io.IOException - unable to read from specified file

open

TemplateDocument open(java.io.InputStream input,
                      java.lang.String extension,
                      java.io.OutputStream output,
                      DocumentFactory.CancellationToken cancellationToken)
               throws java.io.IOException

Opens a document from the specified stream. The extension string indicates the type of document in the stream.

Provided cancellation token can be used to stop processing

Parameters:

input - InputStream containing the template document

extension - type of document in input stream

output - OutputStream will be used to output the processed document

cancellationToken - DocumentFactory.CancellationToken processing can be cancelled by calling cancel() on the provided token

Returns:

Template document interface

Throws:

java.io.IOException - unable to read from stream

open

default TemplateDocument open(java.io.InputStream input,
                              java.lang.String extension,
                              java.io.OutputStream output)
                       throws java.io.IOException

Opens a document from the specified stream. The extension string indicates the type of document in the stream.

It will use cancellation token for the current thread

Parameters:

input - InputStream containing the template document

extension - type of document in input stream

output - OutputStream will be used to output the processed document

Returns:

Template document interface

Throws:

java.io.IOException - unable to read from stream