Java Doc for StreamSource.java in  » 6.0-JDK-Core » xml » javax » xml » transform » stream » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » xml » javax.xml.transform.stream 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.xml.transform.stream.StreamSource

StreamSource
public class StreamSource implements Source(Code)

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.


author:
   Jeff Suttor
version:
   $Revision: 1.4 $, $Date: 2005/11/03 19:34:27 $


Field Summary
final public static  StringFEATURE
     If javax.xml.transform.TransformerFactory.getFeature returns true when passed this value as an argument, the Transformer supports Source input of this type.

Constructor Summary
public  StreamSource()
    

Zero-argument default constructor.

public  StreamSource(InputStream inputStream)
     Construct a StreamSource from a byte stream.
public  StreamSource(InputStream inputStream, String systemId)
     Construct a StreamSource from a byte stream.
public  StreamSource(Reader reader)
     Construct a StreamSource from a character reader.
public  StreamSource(Reader reader, String systemId)
     Construct a StreamSource from a character reader.
public  StreamSource(String systemId)
     Construct a StreamSource from a URL.
public  StreamSource(File f)
     Construct a StreamSource from a File.

Method Summary
public  InputStreamgetInputStream()
     Get the byte stream that was set with setByteStream.
public  StringgetPublicId()
     Get the public identifier that was set with setPublicId.
public  ReadergetReader()
     Get the character stream that was set with setReader.
public  StringgetSystemId()
     Get the system identifier that was set with setSystemId.
public  voidsetInputStream(InputStream inputStream)
     Set the byte stream to be used as input.
public  voidsetPublicId(String publicId)
     Set the public identifier for this Source.
public  voidsetReader(Reader reader)
     Set the input to be a character reader.
public  voidsetSystemId(String systemId)
     Set the system identifier for this Source.
public  voidsetSystemId(File f)
     Set the system ID from a File reference.

Field Detail
FEATURE
final public static String FEATURE(Code)
If javax.xml.transform.TransformerFactory.getFeature returns true when passed this value as an argument, the Transformer supports Source input of this type.




Constructor Detail
StreamSource
public StreamSource()(Code)

Zero-argument default constructor. If this constructor is used, and no Stream source is set using StreamSource.setInputStream(java.io.InputStream inputStream) or StreamSource.setReader(java.io.Reader reader) , then the Transformer will create an empty source java.io.InputStream using java.io.InputStream.InputStream new InputStream() .


See Also:   javax.xml.transform.Transformer.transform(Source xmlSourceResult outputTarget)



StreamSource
public StreamSource(InputStream inputStream)(Code)
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.



StreamSource
public StreamSource(InputStream inputStream, String systemId)(Code)
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.
Parameters:
  systemId - Must be a String that conforms to the URI syntax.



StreamSource
public StreamSource(Reader reader)(Code)
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.



StreamSource
public StreamSource(Reader reader, String systemId)(Code)
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.
Parameters:
  systemId - Must be a String that conforms to the URI syntax.



StreamSource
public StreamSource(String systemId)(Code)
Construct a StreamSource from a URL.
Parameters:
  systemId - Must be a String that conforms to the URI syntax.



StreamSource
public StreamSource(File f)(Code)
Construct a StreamSource from a File.
Parameters:
  f - Must a non-null File reference.




Method Detail
getInputStream
public InputStream getInputStream()(Code)
Get the byte stream that was set with setByteStream. The byte stream that was set with setByteStream, or nullif setByteStream or the ByteStream constructor was not called.



getPublicId
public String getPublicId()(Code)
Get the public identifier that was set with setPublicId. The public identifier that was set with setPublicId, or nullif setPublicId was not called.



getReader
public Reader getReader()(Code)
Get the character stream that was set with setReader. The character stream that was set with setReader, or nullif setReader or the Reader constructor was not called.



getSystemId
public String getSystemId()(Code)
Get the system identifier that was set with setSystemId. The system identifier that was set with setSystemId, or nullif setSystemId was not called.



setInputStream
public void setInputStream(InputStream inputStream)(Code)
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.


Parameters:
  inputStream - A valid InputStream reference to an XML stream.



setPublicId
public void setPublicId(String publicId)(Code)
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.


Parameters:
  publicId - The public identifier as a string.



setReader
public void setReader(Reader reader)(Code)
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.
Parameters:
  reader - A valid Reader reference to an XML CharacterStream.



setSystemId
public void setSystemId(String systemId)(Code)
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).


Parameters:
  systemId - The system identifier as a URL string.



setSystemId
public void setSystemId(File f)(Code)
Set the system ID from a File reference.
Parameters:
  f - Must a non-null File reference.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.