Java Doc for XMLStreamWriter.java in  » 6.0-JDK-Modules » jsr173-Stax » javax » xml » stream » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » jsr173 Stax » javax.xml.stream 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.xml.stream.XMLStreamWriter

XMLStreamWriter
public interface XMLStreamWriter (Code)
The XMLStreamWriter interface specifies how to write XML. The XMLStreamWriter does not perform well formedness checking on its input. However the writeCharacters method is required to escape & , < and > For attribute values the writeAttribute method will escape the above characters plus " to ensure that all character content and attribute values are well formed. Each NAMESPACE and ATTRIBUTE must be individually written. If javax.xml.stream.isPrefixDefaulting is set to false it is a fatal error if an element is written with namespace URI that has not been bound to a prefix. If javax.xml.stream.isPrefixDefaulting is set to true the XMLStreamWriter implementation must write a prefix for each unbound URI that it encounters in the current scope.
version:
   1.0
author:
   Copyright (c) 2003 by BEA Systems. All Rights Reserved.
See Also:   XMLOutputFactory
See Also:   XMLStreamReader




Method Summary
public  voidclose()
     Close this writer and free any resources associated with the writer.
public  voidflush()
     Write any cached data to the underlying output mechanism.
public  NamespaceContextgetNamespaceContext()
     Returns the current namespace context.
public  StringgetPrefix(String uri)
    
public  ObjectgetProperty(java.lang.String name)
    
public  voidsetDefaultNamespace(String uri)
     Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair.
public  voidsetNamespaceContext(NamespaceContext context)
     Sets the current namespace context for prefix and uri bindings. This context becomes the root namespace context for writing and will replace the current root namespace context.
public  voidsetPrefix(String prefix, String uri)
     Sets the prefix the uri is bound to.
public  voidwriteAttribute(String localName, String value)
     Writes an attribute to the output stream without a prefix.
public  voidwriteAttribute(String prefix, String namespaceURI, String localName, String value)
    
public  voidwriteAttribute(String namespaceURI, String localName, String value)
    
public  voidwriteCData(String data)
    
public  voidwriteCharacters(String text)
    
public  voidwriteCharacters(char[] text, int start, int len)
    
public  voidwriteComment(String data)
    
public  voidwriteDTD(String dtd)
     Write a DTD section.
public  voidwriteDefaultNamespace(String namespaceURI)
    
public  voidwriteEmptyElement(String namespaceURI, String localName)
    
public  voidwriteEmptyElement(String prefix, String localName, String namespaceURI)
    
public  voidwriteEmptyElement(String localName)
    
public  voidwriteEndDocument()
     Closes any start tags and writes corresponding end tags.
public  voidwriteEndElement()
     Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.
public  voidwriteEntityRef(String name)
    
public  voidwriteNamespace(String prefix, String namespaceURI)
    
public  voidwriteProcessingInstruction(String target)
    
public  voidwriteProcessingInstruction(String target, String data)
    
public  voidwriteStartDocument()
     Write the XML Declaration.
public  voidwriteStartDocument(String version)
     Write the XML Declaration.
public  voidwriteStartDocument(String encoding, String version)
     Write the XML Declaration.
public  voidwriteStartElement(String localName)
     Writes a start tag to the output.
public  voidwriteStartElement(String namespaceURI, String localName)
    
public  voidwriteStartElement(String prefix, String localName, String namespaceURI)
    



Method Detail
close
public void close() throws XMLStreamException(Code)
Close this writer and free any resources associated with the writer. This must not close the underlying output stream.
throws:
  XMLStreamException -



flush
public void flush() throws XMLStreamException(Code)
Write any cached data to the underlying output mechanism.
throws:
  XMLStreamException -



getNamespaceContext
public NamespaceContext getNamespaceContext()(Code)
Returns the current namespace context. the current NamespaceContext



getPrefix
public String getPrefix(String uri) throws XMLStreamException(Code)
Gets the prefix the uri is bound to the prefix or null
throws:
  XMLStreamException -



getProperty
public Object getProperty(java.lang.String name) throws IllegalArgumentException(Code)
Get the value of a feature/property from the underlying implementation
Parameters:
  name - The name of the property, may not be null The value of the property
throws:
  IllegalArgumentException - if the property is not supported
throws:
  NullPointerException - if the name is null



setDefaultNamespace
public void setDefaultNamespace(String uri) throws XMLStreamException(Code)
Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the uri is bound in the root scope.
Parameters:
  uri - the uri to bind to the default namespace, may be null
throws:
  XMLStreamException -



setNamespaceContext
public void setNamespaceContext(NamespaceContext context) throws XMLStreamException(Code)
Sets the current namespace context for prefix and uri bindings. This context becomes the root namespace context for writing and will replace the current root namespace context. Subsequent calls to setPrefix and setDefaultNamespace will bind namespaces using the context passed to the method as the root context for resolving namespaces. This method may only be called once at the start of the document. It does not cause the namespaces to be declared. If a namespace URI to prefix mapping is found in the namespace context it is treated as declared and the prefix may be used by the StreamWriter.
Parameters:
  context - the namespace context to use for this writer, may not be null
throws:
  XMLStreamException -



setPrefix
public void setPrefix(String prefix, String uri) throws XMLStreamException(Code)
Sets the prefix the uri is bound to. This prefix is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. If this method is called before a START_ELEMENT has been written the prefix is bound in the root scope.
Parameters:
  prefix - the prefix to bind to the uri, may not be null
Parameters:
  uri - the uri to bind to the prefix, may be null
throws:
  XMLStreamException -



writeAttribute
public void writeAttribute(String localName, String value) throws XMLStreamException(Code)
Writes an attribute to the output stream without a prefix.
Parameters:
  localName - the local name of the attribute
Parameters:
  value - the value of the attribute
throws:
  IllegalStateException - if the current state does not allow Attribute writing
throws:
  XMLStreamException -



writeAttribute
public void writeAttribute(String prefix, String namespaceURI, String localName, String value) throws XMLStreamException(Code)
Writes an attribute to the output stream
Parameters:
  prefix - the prefix for this attribute
Parameters:
  namespaceURI - the uri of the prefix for this attribute
Parameters:
  localName - the local name of the attribute
Parameters:
  value - the value of the attribute
throws:
  IllegalStateException - if the current state does not allow Attribute writing
throws:
  XMLStreamException - if the namespace URI has not been bound to a prefix andjavax.xml.stream.isPrefixDefaulting has not been set to true



writeAttribute
public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException(Code)
Writes an attribute to the output stream
Parameters:
  namespaceURI - the uri of the prefix for this attribute
Parameters:
  localName - the local name of the attribute
Parameters:
  value - the value of the attribute
throws:
  IllegalStateException - if the current state does not allow Attribute writing
throws:
  XMLStreamException - if the namespace URI has not been bound to a prefix andjavax.xml.stream.isPrefixDefaulting has not been set to true



writeCData
public void writeCData(String data) throws XMLStreamException(Code)
Writes a CData section
Parameters:
  data - the data contained in the CData Section, may not be null
throws:
  XMLStreamException -



writeCharacters
public void writeCharacters(String text) throws XMLStreamException(Code)
Write text to the output
Parameters:
  text - the value to write
throws:
  XMLStreamException -



writeCharacters
public void writeCharacters(char[] text, int start, int len) throws XMLStreamException(Code)
Write text to the output
Parameters:
  text - the value to write
Parameters:
  start - the starting position in the array
Parameters:
  len - the number of characters to write
throws:
  XMLStreamException -



writeComment
public void writeComment(String data) throws XMLStreamException(Code)
Writes an xml comment with the data enclosed
Parameters:
  data - the data contained in the comment, may be null
throws:
  XMLStreamException -



writeDTD
public void writeDTD(String dtd) throws XMLStreamException(Code)
Write a DTD section. This string represents the entire doctypedecl production from the XML 1.0 specification.
Parameters:
  dtd - the DTD to be written
throws:
  XMLStreamException -



writeDefaultNamespace
public void writeDefaultNamespace(String namespaceURI) throws XMLStreamException(Code)
Writes the default namespace to the stream
Parameters:
  namespaceURI - the uri to bind the default namespace to
throws:
  IllegalStateException - if the current state does not allow Namespace writing
throws:
  XMLStreamException -



writeEmptyElement
public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException(Code)
Writes an empty element tag to the output
Parameters:
  namespaceURI - the uri to bind the tag to, may not be null
Parameters:
  localName - local name of the tag, may not be null
throws:
  XMLStreamException - if the namespace URI has not been bound to a prefix andjavax.xml.stream.isPrefixDefaulting has not been set to true



writeEmptyElement
public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException(Code)
Writes an empty element tag to the output
Parameters:
  prefix - the prefix of the tag, may not be null
Parameters:
  localName - local name of the tag, may not be null
Parameters:
  namespaceURI - the uri to bind the tag to, may not be null
throws:
  XMLStreamException -



writeEmptyElement
public void writeEmptyElement(String localName) throws XMLStreamException(Code)
Writes an empty element tag to the output
Parameters:
  localName - local name of the tag, may not be null
throws:
  XMLStreamException -



writeEndDocument
public void writeEndDocument() throws XMLStreamException(Code)
Closes any start tags and writes corresponding end tags.
throws:
  XMLStreamException -



writeEndElement
public void writeEndElement() throws XMLStreamException(Code)
Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.
throws:
  XMLStreamException -



writeEntityRef
public void writeEntityRef(String name) throws XMLStreamException(Code)
Writes an entity reference
Parameters:
  name - the name of the entity
throws:
  XMLStreamException -



writeNamespace
public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException(Code)
Writes a namespace to the output stream If the prefix argument to this method is the empty string, "xmlns", or null this method will delegate to writeDefaultNamespace
Parameters:
  prefix - the prefix to bind this namespace to
Parameters:
  namespaceURI - the uri to bind the prefix to
throws:
  IllegalStateException - if the current state does not allow Namespace writing
throws:
  XMLStreamException -



writeProcessingInstruction
public void writeProcessingInstruction(String target) throws XMLStreamException(Code)
Writes a processing instruction
Parameters:
  target - the target of the processing instruction, may not be null
throws:
  XMLStreamException -



writeProcessingInstruction
public void writeProcessingInstruction(String target, String data) throws XMLStreamException(Code)
Writes a processing instruction
Parameters:
  target - the target of the processing instruction, may not be null
Parameters:
  data - the data contained in the processing instruction, may not be null
throws:
  XMLStreamException -



writeStartDocument
public void writeStartDocument() throws XMLStreamException(Code)
Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8
throws:
  XMLStreamException -



writeStartDocument
public void writeStartDocument(String version) throws XMLStreamException(Code)
Write the XML Declaration. Defaults the XML version to 1.0
Parameters:
  version - version of the xml document
throws:
  XMLStreamException -



writeStartDocument
public void writeStartDocument(String encoding, String version) throws XMLStreamException(Code)
Write the XML Declaration. Note that the encoding parameter does not set the actual encoding of the underlying output. That must be set when the instance of the XMLStreamWriter is created using the XMLOutputFactory
Parameters:
  encoding - encoding of the xml declaration
Parameters:
  version - version of the xml document
throws:
  XMLStreamException -



writeStartElement
public void writeStartElement(String localName) throws XMLStreamException(Code)
Writes a start tag to the output. All writeStartElement methods open a new scope in the internal namespace context. Writing the corresponding EndElement causes the scope to be closed.
Parameters:
  localName - local name of the tag, may not be null
throws:
  XMLStreamException -



writeStartElement
public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException(Code)
Writes a start tag to the output
Parameters:
  namespaceURI - the namespaceURI of the prefix to use, may not be null
Parameters:
  localName - local name of the tag, may not be null
throws:
  XMLStreamException - if the namespace URI has not been bound to a prefix andjavax.xml.stream.isPrefixDefaulting has not been set to true



writeStartElement
public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException(Code)
Writes a start tag to the output
Parameters:
  localName - local name of the tag, may not be null
Parameters:
  prefix - the prefix of the tag, may not be null
Parameters:
  namespaceURI - the uri to bind the prefix to, may not be null
throws:
  XMLStreamException -



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