Package javax.xml.transform.stream
Class StreamResult
java.lang.Object
javax.xml.transform.stream.StreamResult
- All Implemented Interfaces:
Result
Acts as an holder for a transformation result, which may be XML, plain Text, HTML, or some other form of markup.
- Author:
- Jeff Suttor
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final java.lang.String
IfTransformerFactory.getFeature(java.lang.String)
returns true when passed this value as an argument, the Transformer supports Result output of this type.Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
ConstructorsConstructorDescriptionZero-argument default constructor.StreamResult
(java.io.File f) Construct a StreamResult from a File.StreamResult
(java.io.OutputStream outputStream) Construct a StreamResult from a byte stream.StreamResult
(java.io.Writer writer) Construct a StreamResult from a character stream.StreamResult
(java.lang.String systemId) Construct a StreamResult from a URL. -
Method Summary
Modifier and TypeMethodDescriptionjava.io.OutputStream
Get the byte stream that was set with setOutputStream.java.lang.String
Get the system identifier that was set with setSystemId.java.io.Writer
Get the character stream that was set with setWriter.void
setOutputStream
(java.io.OutputStream outputStream) Set the ByteStream that is to be written to.void
setSystemId
(java.io.File f) Set the system ID from aFile
reference.void
setSystemId
(java.lang.String systemId) Set the systemID that may be used in association with the byte or character stream, or, if neither is set, use this value as a writeable URI (probably a file name).void
setWriter
(java.io.Writer writer) Set the writer that is to receive the result.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
FEATURE
public static final java.lang.String FEATUREIfTransformerFactory.getFeature(java.lang.String)
returns true when passed this value as an argument, the Transformer supports Result output of this type.- See Also:
-
-
Constructor Details
-
StreamResult
public StreamResult()Zero-argument default constructor. -
StreamResult
public StreamResult(java.io.OutputStream outputStream) Construct a StreamResult from a byte stream. Normally, a stream should be used rather than a reader, so that the transformer may use instructions contained in the transformation instructions to control the encoding.- Parameters:
outputStream
- A valid OutputStream reference.
-
StreamResult
public StreamResult(java.io.Writer writer) Construct a StreamResult from a character stream. Normally, a stream should be used rather than a reader, so that the transformer may use instructions contained in the transformation instructions to control the encoding. However, there are times when it is useful to write to a character stream, such as when using a StringWriter.- Parameters:
writer
- A valid Writer reference.
-
StreamResult
public StreamResult(java.lang.String systemId) Construct a StreamResult from a URL.- Parameters:
systemId
- Must be a String that conforms to the URI syntax.
-
StreamResult
public StreamResult(java.io.File f) Construct a StreamResult from a File.- Parameters:
f
- Must a non-null File reference.
-
-
Method Details
-
setOutputStream
public void setOutputStream(java.io.OutputStream outputStream) Set the ByteStream that is to be written to. Normally, a stream should be used rather than a reader, so that the transformer may use instructions contained in the transformation instructions to control the encoding.- Parameters:
outputStream
- A valid OutputStream reference.
-
getOutputStream
public java.io.OutputStream getOutputStream()Get the byte stream that was set with setOutputStream.- Returns:
- The byte stream that was set with setOutputStream, or null if setOutputStream or the ByteStream constructor was not called.
-
setWriter
public void setWriter(java.io.Writer writer) Set the writer that is to receive the result. Normally, a stream should be used rather than a writer, so that the transformer may use instructions contained in the transformation instructions to control the encoding. However, there are times when it is useful to write to a writer, such as when using a StringWriter.- Parameters:
writer
- A valid Writer reference.
-
getWriter
public java.io.Writer getWriter()Get the character stream that was set with setWriter.- Returns:
- The character stream that was set with setWriter, or null if setWriter or the Writer constructor was not called.
-
setSystemId
public void setSystemId(java.lang.String systemId) Set the systemID that may be used in association with the byte or character stream, or, if neither is set, use this value as a writeable URI (probably a file name).- Specified by:
setSystemId
in interfaceResult
- Parameters:
systemId
- The system identifier as a URI string.
-
setSystemId
public void setSystemId(java.io.File f) Set the system ID from a
File
reference.Note the use of
File.toURI()
andFile.toURL()
.toURI()
is preferred and used if possible. To allow JAXP 1.3 to run on J2SE 1.3,toURL()
is used if aNoSuchMethodException
is thrown by the attempt to usetoURI()
.- Parameters:
f
- Must a non-null File reference.
-
getSystemId
public java.lang.String getSystemId()Get the system identifier that was set with setSystemId.- Specified by:
getSystemId
in interfaceResult
- Returns:
- The system identifier that was set with setSystemId, or null if setSystemId was not called.
-