|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.xml.transform.stream.StreamSource
public class StreamSource
Acts as an holder for a transformation Source in the form of a stream of XML markup.
Note: Due to their internal use of either a Reader
or InputStream
instance,
StreamSource
instances may only be used once.
Field Summary | |
---|---|
static java.lang.String |
FEATURE
If TransformerFactory.getFeature(java.lang.String)
returns true when passed this value as an argument,
the Transformer supports Source input of this type. |
Constructor Summary | |
---|---|
StreamSource()
Zero-argument default constructor. |
|
StreamSource(java.io.File f)
Construct a StreamSource from a File. |
|
StreamSource(java.io.InputStream inputStream)
Construct a StreamSource from a byte stream. |
|
StreamSource(java.io.InputStream inputStream,
java.lang.String systemId)
Construct a StreamSource from a byte stream. |
|
StreamSource(java.io.Reader reader)
Construct a StreamSource from a character reader. |
|
StreamSource(java.io.Reader reader,
java.lang.String systemId)
Construct a StreamSource from a character reader. |
|
StreamSource(java.lang.String systemId)
Construct a StreamSource from a URL. |
Method Summary | |
---|---|
java.io.InputStream |
getInputStream()
Get the byte stream that was set with setByteStream. |
java.lang.String |
getPublicId()
Get the public identifier that was set with setPublicId. |
java.io.Reader |
getReader()
Get the character stream that was set with setReader. |
java.lang.String |
getSystemId()
Get the system identifier that was set with setSystemId. |
void |
setInputStream(java.io.InputStream inputStream)
Set the byte stream to be used as input. |
void |
setPublicId(java.lang.String publicId)
Set the public identifier for this Source. |
void |
setReader(java.io.Reader reader)
Set the input to be a character reader. |
void |
setSystemId(java.io.File f)
Set the system ID from a File reference. |
void |
setSystemId(java.lang.String systemId)
Set the system identifier for this Source. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FEATURE
TransformerFactory.getFeature(java.lang.String)
returns true when passed this value as an argument,
the Transformer supports Source input of this type.
Constructor Detail |
---|
public StreamSource()
Zero-argument default constructor. If this constructor is used, and
no Stream source is set using
setInputStream(java.io.InputStream inputStream)
or
setReader(java.io.Reader reader)
, then the
Transformer
will
create an empty source InputStream
using
new InputStream()
.
Transformer.transform(Source xmlSource, Result outputTarget)
public StreamSource(java.io.InputStream inputStream)
If this constructor is used to process a stylesheet, normally setSystemId should also be called, so that relative URI references can be resolved.
inputStream
- A valid InputStream reference to an XML stream.public StreamSource(java.io.InputStream inputStream, java.lang.String systemId)
This constructor allows the systemID to be set in addition to the input stream, which allows relative URIs to be processed.
inputStream
- A valid InputStream reference to an XML stream.systemId
- Must be a String that conforms to the URI syntax.public StreamSource(java.io.Reader reader)
reader
- A valid Reader reference to an XML character stream.public StreamSource(java.io.Reader reader, java.lang.String systemId)
reader
- A valid Reader reference to an XML character stream.systemId
- Must be a String that conforms to the URI syntax.public StreamSource(java.lang.String systemId)
systemId
- Must be a String that conforms to the URI syntax.public StreamSource(java.io.File f)
f
- Must a non-null File reference.Method Detail |
---|
public void setInputStream(java.io.InputStream inputStream)
If this Source object is used to process a stylesheet, normally setSystemId should also be called, so that relative URL references can be resolved.
inputStream
- A valid InputStream reference to an XML stream.public java.io.InputStream getInputStream()
public void setReader(java.io.Reader reader)
reader
- A valid Reader reference to an XML CharacterStream.public java.io.Reader getReader()
public void setPublicId(java.lang.String publicId)
The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information.
publicId
- The public identifier as a string.public java.lang.String getPublicId()
public void setSystemId(java.lang.String systemId)
The system identifier is optional if there is a byte stream or a character stream, but it is still useful to provide one, since the application can use it to resolve relative URIs and can include it in error messages and warnings (the parser will attempt to open a connection to the URI only if there is no byte stream or character stream specified).
setSystemId
in interface Source
systemId
- The system identifier as a URL string.public java.lang.String getSystemId()
getSystemId
in interface Source
public void setSystemId(java.io.File f)
f
- Must a non-null File reference.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |