Home » xml-commons-external-1.4.01-src » javax » xml » transform » stream » [javadoc | source]
javax.xml.transform.stream
public class: StreamSource [javadoc | source]
java.lang.Object
   javax.xml.transform.stream.StreamSource

All Implemented Interfaces:
    Source

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
public static final  String FEATURE    If javax.xml.transform.TransformerFactory#getFeature returns true when passed this value as an argument, the Transformer supports Source input of this type. 
Constructor:
 public StreamSource() 
    Also see:
    javax.xml.transform.Transformer#transform(Source xmlSource, Result outputTarget)
 public StreamSource(InputStream inputStream) 
    Construct a StreamSource from a byte stream. Normally, a stream should be used rather than a reader, so the XML parser can resolve character encoding specified by the XML declaration.

    If this constructor is used to process a stylesheet, normally setSystemId should also be called, so that relative URI references can be resolved.

    Parameters:
    inputStream - A valid InputStream reference to an XML stream.
 public StreamSource(Reader reader) 
    Construct a StreamSource from a character reader. Normally, a stream should be used rather than a reader, so that the XML parser can resolve character encoding specified by the XML declaration. However, in many cases the encoding of the input stream is already resolved, as in the case of reading XML from a StringReader.
    Parameters:
    reader - A valid Reader reference to an XML character stream.
 public StreamSource(String systemId) 
    Construct a StreamSource from a URL.
    Parameters:
    systemId - Must be a String that conforms to the URI syntax.
 public StreamSource(File f) 
    Construct a StreamSource from a File.
    Parameters:
    f - Must a non-null File reference.
 public StreamSource(InputStream inputStream,
    String systemId) 
    Construct a StreamSource from a byte stream. Normally, a stream should be used rather than a reader, so that the XML parser can resolve character encoding specified by the XML declaration.

    This constructor allows the systemID to be set in addition to the input stream, which allows relative URIs to be processed.

    Parameters:
    inputStream - A valid InputStream reference to an XML stream.
    systemId - Must be a String that conforms to the URI syntax.
 public StreamSource(Reader reader,
    String systemId) 
    Construct a StreamSource from a character reader. Normally, a stream should be used rather than a reader, so that the XML parser may resolve character encoding specified by the XML declaration. However, in many cases the encoding of the input stream is already resolved, as in the case of reading XML from a StringReader.
    Parameters:
    reader - A valid Reader reference to an XML character stream.
    systemId - Must be a String that conforms to the URI syntax.
Method from javax.xml.transform.stream.StreamSource Summary:
getInputStream,   getPublicId,   getReader,   getSystemId,   setInputStream,   setPublicId,   setReader,   setSystemId,   setSystemId
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.transform.stream.StreamSource Detail:
 public InputStream getInputStream() 
    Get the byte stream that was set with setByteStream.
 public String getPublicId() 
    Get the public identifier that was set with setPublicId.
 public Reader getReader() 
    Get the character stream that was set with setReader.
 public String getSystemId() 
    Get the system identifier that was set with setSystemId.
 public  void setInputStream(InputStream inputStream) 
    Set the byte stream to be used as input. Normally, a stream should be used rather than a reader, so that the XML parser can resolve character encoding specified by the XML declaration.

    If this Source object is used to process a stylesheet, normally setSystemId should also be called, so that relative URL references can be resolved.

 public  void setPublicId(String publicId) 
    Set the public identifier for this Source.

    The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information.

 public  void setReader(Reader reader) 
    Set the input to be a character reader. Normally, a stream should be used rather than a reader, so that the XML parser can resolve character encoding specified by the XML declaration. However, in many cases the encoding of the input stream is already resolved, as in the case of reading XML from a StringReader.
 public  void setSystemId(String systemId) 
    Set the system identifier for this Source.

    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).

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