Class Stax2BlockResult

java.lang.Object

org.codehaus.stax2.io.Stax2Result

org.codehaus.stax2.io.Stax2BlockResult

All Implemented Interfaces:

Result

public abstract class Stax2BlockResult
extends Stax2Result

This is the mid-level abstract base class for Stax2Results that an be used to write to in-memory (low-level) data structures, such as byte and char arrays, StringBuffers and so forth. The main reason for using such a result object (instead of constructing wrapper Readers or InputStreams) is that concrete implementations usually also allow more direct access to the underlying data, so that stream reader implementations may be able to do more optimal access.

Field Summary

Fields inherited from class Stax2Result

mEncoding, mPublicId, mSystemId

Fields inherited from interface Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Stax2BlockResult()

Method Summary

Modifier and Type	Method	Description
abstract OutputStream	constructOutputStream()	This method creates an OutputStream via which underlying output target can be written to.
abstract Writer	constructWriter()	This method creates a Writer via which underlying output target can be written to.

Methods inherited from class Stax2Result

getEncoding, getPublicId, getSystemId, setEncoding, setPublicId, setSystemId

Methods inherited from class Object

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

Constructor Details

Stax2BlockResult

protected Stax2BlockResult()

Method Details

constructWriter

public abstract Writer constructWriter()
                                throws IOException

Description copied from class: Stax2Result

This method creates a Writer via which underlying output target can be written to. Note that caller is responsible for closing that Writer when it is done reading it.

Specified by:

constructWriter in class Stax2Result

Throws:

IOException

constructOutputStream

public abstract OutputStream constructOutputStream()
                                            throws IOException

Description copied from class: Stax2Result

This method creates an OutputStream via which underlying output target can be written to. Note that caller is responsible for closing that OutputStream when it is done reading it

Specified by:

constructOutputStream in class Stax2Result

Throws:

IOException