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.
- Since:
- 1.4
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
IfTransformerFactory.getFeature(java.lang.String)
returns true when passed this value as an argument, the Transformer supports Result output of this type.Fields declared in interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
ConstructorDescriptionZero-argument default constructor.StreamResult
(File f) Construct a StreamResult from a File.StreamResult
(OutputStream outputStream) Construct a StreamResult from a byte stream.StreamResult
(Writer writer) Construct a StreamResult from a character stream.StreamResult
(String systemId) Construct a StreamResult from a URL. -
Method Summary
Modifier and TypeMethodDescriptionGet the byte stream that was set with setOutputStream.Get the system identifier that was set with setSystemId.Get the character stream that was set with setWriter.void
setOutputStream
(OutputStream outputStream) Set the ByteStream that is to be written to.void
setSystemId
(File f) Set the system ID from aFile
reference.void
setSystemId
(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
Set the writer that is to receive the result.
-
Field Details
-
FEATURE
IfTransformerFactory.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
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
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
Construct a StreamResult from a URL.- Parameters:
systemId
- Must be a String that conforms to the URI syntax.
-
StreamResult
Construct a StreamResult from a File.- Parameters:
f
- Must a non-null File reference.
-
-
Method Details
-
setOutputStream
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
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
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
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
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
Set the system ID from a
File
reference.- Parameters:
f
- Must a non-null File reference.
-
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.
-