org.codehaus.stax2.io
Class Stax2Result
java.lang.Object
org.codehaus.stax2.io.Stax2Result
- All Implemented Interfaces:
- Result
- Direct Known Subclasses:
- Stax2BlockResult, Stax2ReferentialResult
public abstract class Stax2Result
- extends Object
- implements Result
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
and
OutputStream
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.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
mSystemId
protected String mSystemId
mPublicId
protected String mPublicId
mEncoding
protected String mEncoding
Stax2Result
protected Stax2Result()
getSystemId
public String getSystemId()
- Specified by:
getSystemId
in interface Result
setSystemId
public void setSystemId(String id)
- Specified by:
setSystemId
in interface Result
getPublicId
public String getPublicId()
setPublicId
public void setPublicId(String id)
getEncoding
public String getEncoding()
setEncoding
public void setEncoding(String enc)
constructWriter
public abstract Writer constructWriter()
throws IOException
- 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.
- Throws:
IOException
constructOutputStream
public abstract OutputStream constructOutputStream()
throws IOException
- 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
- Throws:
IOException
Copyright © 2011 Codehaus. All Rights Reserved.