Package org.codehaus.stax2.io
Class Stax2Result
java.lang.Object
org.codehaus.stax2.io.Stax2Result
- All Implemented Interfaces:
Result
- Direct Known Subclasses:
Stax2BlockResult
,Stax2ReferentialResult
This is the base class for additional output results (implementations
of
Result
) that Stax2
XMLInputFactory2
implementations should support.
Note about usage by the parser factory implementations: the expectation
is that at least one of methods constructWriter()
and
constructOutputStream()
will succeed, but not necessarily both.
This generally depends on type of resource being represented: for example,
if the source is a StringBuffer, it is most naturally
represent via Writer
. For File-backed results, on the other hand,
an OutputStream
is the most natural access method.
Other things to note about using result Writer
s and
OutputStream
s:
- Caller is responsible for closing any
Writer
andOutputStream
instances requested. That is, caller owns these accessor objects. - Result objects are only required to return a non-null object once: after this, if new non-null instances are returned, they must not be the same objects as returned earlier. Implementations can choose to construct new instances to the same backing data structure or resource; if so, they should document this behavior.
-
Field Summary
FieldsFields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract OutputStream
This method creates anOutputStream
via which underlying output target can be written to.abstract Writer
This method creates aWriter
via which underlying output target can be written to.void
setEncoding
(String enc) void
setPublicId
(String id) void
setSystemId
(String id)
-
Field Details
-
mSystemId
-
mPublicId
-
mEncoding
-
-
Constructor Details
-
Stax2Result
protected Stax2Result()
-
-
Method Details
-
getSystemId
- Specified by:
getSystemId
in interfaceResult
-
setSystemId
- Specified by:
setSystemId
in interfaceResult
-
getPublicId
-
setPublicId
-
getEncoding
-
setEncoding
-
constructWriter
This method creates aWriter
via which underlying output target can be written to. Note that caller is responsible for closing that Writer when it is done reading it.- Throws:
IOException
-
constructOutputStream
This method creates anOutputStream
via which underlying output target can be written to. Note that caller is responsible for closing that OutputStream when it is done reading it- Throws:
IOException
-