javax.xml.transform.stream

Class StreamResult

Implemented Interfaces:
Result

public class StreamResult
extends Object
implements Result

Specifies a stream to which to write the transformation result.

Field Summary

static String
FEATURE
Factory feature indicating that stream results are supported.

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

StreamResult()
Default constructor.
StreamResult(File file)
Constructor with a system ID specified as a File object.
StreamResult(OutputStream stream)
Constructor with an output stream.
StreamResult(Writer writer)
Constructor with a writer.
StreamResult(String systemID)
Constructor with a system ID.

Method Summary

OutputStream
getOutputStream()
Returns the target output stream.
String
getSystemId()
Returns the system ID.
Writer
getWriter()
Returns the target writer.
void
setOutputStream(OutputStream outputStream)
Sets the target output stream.
void
setSystemId(File f)
Sets the system ID from a File reference.
void
setSystemId(String systemID)
Sets the system ID.
void
setWriter(Writer writer)
Sets the target writer.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FEATURE

public static final String FEATURE
Factory feature indicating that stream results are supported.
Field Value:
"http://javax.xml.transform.stream.StreamResult/feature"

Constructor Details

StreamResult

public StreamResult()
Default constructor.

StreamResult

public StreamResult(File file)
Constructor with a system ID specified as a File object.

StreamResult

public StreamResult(OutputStream stream)
Constructor with an output stream.

StreamResult

public StreamResult(Writer writer)
Constructor with a writer. Prefer to use an output stream rather than a writer, so that the output encoding can be controlled by transformation properties.

StreamResult

public StreamResult(String systemID)
Constructor with a system ID.

Method Details

getOutputStream

public OutputStream getOutputStream()
Returns the target output stream.

getSystemId

public String getSystemId()
Returns the system ID.
Specified by:
getSystemId in interface Result

getWriter

public Writer getWriter()
Returns the target writer.

setOutputStream

public void setOutputStream(OutputStream outputStream)
Sets the target output stream.

setSystemId

public void setSystemId(File f)
Sets the system ID from a File reference.

setSystemId

public void setSystemId(String systemID)
Sets the system ID. If neither the out stream nor the writer have been specified, the system ID will be treated as a URL for writing to.
Specified by:
setSystemId in interface Result

setWriter

public void setWriter(Writer writer)
Sets the target writer. Prefer to use an output stream rather than a writer, so that the output encoding can be controlled by transformation properties.

StreamResult.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.