Module io.xlate.staedi

Package io.xlate.edi.stream

Class EDIOutputFactory

java.lang.Object

io.xlate.edi.stream.PropertySupport

io.xlate.edi.stream.EDIOutputFactory

public abstract class EDIOutputFactory
extends PropertySupport

Field Summary

Fields

Modifier and Type	Field	Description
static String	PRETTY_PRINT

Fields inherited from class io.xlate.edi.stream.PropertySupport

properties, supportedProperties

Constructor Summary

Constructors

Constructor	Description
EDIOutputFactory()

Method Summary

Modifier and Type	Method	Description
abstract EDIStreamWriter	createEDIStreamWriter(OutputStream stream)	Create a new EDIStreamWriter that writes to a stream
abstract EDIStreamWriter	createEDIStreamWriter(OutputStream stream, String encoding)	Create a new EDIStreamWriter that writes to a stream
abstract XMLStreamWriter	createXMLStreamWriter(EDIStreamWriter writer)	Creates a new XMLStreamWriter that uses the given writer as its output.
static EDIOutputFactory	newFactory()	Create a new instance of the factory.

Methods inherited from class io.xlate.edi.stream.PropertySupport

getProperty, isPropertySupported, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

PRETTY_PRINT

public static final String PRETTY_PRINT

See Also:

Constant Field Values

Constructor Detail

EDIOutputFactory

public EDIOutputFactory()

Method Detail

newFactory

public static EDIOutputFactory newFactory()

Create a new instance of the factory. This static method creates a new factory instance. Once an application has obtained a reference to an EDIOutputFactory it can use the factory to configure and obtain stream instances.

Returns:

the factory implementation

createEDIStreamWriter

public abstract EDIStreamWriter createEDIStreamWriter(OutputStream stream)

Create a new EDIStreamWriter that writes to a stream

Parameters:

stream - OutputStream to which the EDI data will be written

Returns:

the writer instance

createEDIStreamWriter

public abstract EDIStreamWriter createEDIStreamWriter(OutputStream stream,
                                                      String encoding)
                                               throws EDIStreamException

Create a new EDIStreamWriter that writes to a stream

Parameters:

stream - OutputStream to which the EDI data will be written

encoding - character encoding of the stream, must be a valid Charset.

Returns:

the writer instance

Throws:

EDIStreamException - when encoding is not supported

createXMLStreamWriter

public abstract XMLStreamWriter createXMLStreamWriter(EDIStreamWriter writer)

Creates a new XMLStreamWriter that uses the given writer as its output. XML Elements written to the writer must use the namespaces declared by the constants in EDINamespaces. The sequence of elements is critical and must align with the structure of the intended EDI output to be written via the given EDI writer.

Parameters:

writer - the writer used to generate EDI output using the XML writer

Returns:

a new XMLStreamWriter