Java Doc for StAXSource.java in  » 6.0-JDK-Core » xml » javax » xml » transform » stax » 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.stax 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.xml.transform.stax.StAXSource

StAXSource
public class StAXSource implements Source(Code)

Acts as a holder for an XML Source in the form of a StAX reader,i.e. XMLStreamReader or XMLEventReader . StAXSource can be used in all cases that accept a Source, e.g. javax.xml.transform.Transformer , javax.xml.validation.Validator which accept Source as input.

StAXSources are consumed during processing and are not reusable.


author:
   Neeraj Bajaj
author:
   Jeff Suttor
version:
   $Revision: 1.4 $, $Date: 2006/04/24 13:42:27 $
See Also:    * JSR 173: Streaming API for XML
See Also:   XMLStreamReader
See Also:   XMLEventReader
since:
   1.6


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

Constructor Summary
public  StAXSource(XMLEventReader xmlEventReader)
    
public  StAXSource(XMLStreamReader xmlStreamReader)
    

Method Summary
public  StringgetSystemId()
    
public  XMLEventReadergetXMLEventReader()
    

Get the XMLEventReader used by this StAXSource.

XMLEventReader will be null.

public  XMLStreamReadergetXMLStreamReader()
    
public  voidsetSystemId(String systemId)
    

In the context of a StAXSource, it is not appropriate to explicitly set the system identifier.


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



Constructor Detail
StAXSource
public StAXSource(XMLEventReader xmlEventReader) throws XMLStreamException(Code)

Creates a new instance of a StAXSource by supplying an XMLEventReader .

XMLEventReader must be a non-null reference.

XMLEventReader must be in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.


Parameters:
  xmlEventReader - XMLEventReader used to createthis StAXSource.
throws:
  XMLStreamException - If xmlEventReader accessthrows an Exception.
throws:
  IllegalArgumentException - If xmlEventReader ==null.
throws:
  IllegalStateException - If xmlEventReaderis not in XMLStreamConstants.START_DOCUMENT orXMLStreamConstants.START_ELEMENT state.


StAXSource
public StAXSource(XMLStreamReader xmlStreamReader)(Code)

Creates a new instance of a StAXSource by supplying an XMLStreamReader .

XMLStreamReader must be a non-null reference.

XMLStreamReader must be in XMLStreamConstants.START_DOCUMENT or XMLStreamConstants.START_ELEMENT state.


Parameters:
  xmlStreamReader - XMLStreamReader used to createthis StAXSource.
throws:
  IllegalArgumentException - If xmlStreamReader ==null.
throws:
  IllegalStateException - If xmlStreamReaderis not in XMLStreamConstants.START_DOCUMENT orXMLStreamConstants.START_ELEMENT state.



Method Detail
getSystemId
public String getSystemId()(Code)

Get the system identifier used by this StAXSource.

The XMLStreamReader or XMLEventReader used to construct this StAXSource is queried to determine the system identifier of the XML source.

The system identifier may be null or an empty "" String.

System identifier used by this StAXSource.


getXMLEventReader
public XMLEventReader getXMLEventReader()(Code)

Get the XMLEventReader used by this StAXSource.

XMLEventReader will be null. if this StAXSource was created with a XMLStreamReader.

XMLEventReader used by thisStAXSource.


getXMLStreamReader
public XMLStreamReader getXMLStreamReader()(Code)

Get the XMLStreamReader used by this StAXSource.

XMLStreamReader will be null if this StAXSource was created with a XMLEventReader.

XMLStreamReader used by thisStAXSource.


setSystemId
public void setSystemId(String systemId)(Code)

In the context of a StAXSource, it is not appropriate to explicitly set the system identifier. The XMLStreamReader or XMLEventReader used to construct this StAXSource determines the system identifier of the XML source.

An UnsupportedOperationException is always thrown by this method.


Parameters:
  systemId - Ignored.
throws:
  UnsupportedOperationException - Is alwaysthrown by this method.


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.