Java Doc for DataWriter.java in  » 6.0-JDK-Modules » jaxb-impl » com » sun » xml » bind » marshaller » 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 » jaxb impl » com.sun.xml.bind.marshaller 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.sun.xml.bind.marshaller.XMLWriter
   com.sun.xml.bind.marshaller.DataWriter

DataWriter
public class DataWriter extends XMLWriter (Code)
Write data- or field-oriented XML.

This filter pretty-prints field-oriented XML without mixed content. all added indentation and newlines will be passed on down the filter chain (if any).

In general, all whitespace in an XML document is potentially significant, so a general-purpose XML writing tool like the XMLWriter class cannot add newlines or indentation.

There is, however, a large class of XML documents where information is strictly fielded: each element contains either character data or other elements, but not both. For this special case, it is possible for a writing tool to provide automatic indentation and newlines without requiring extra work from the user. Note that this class will likely not yield appropriate results for document-oriented XML like XHTML pages, which mix character data and elements together.

This writer will automatically place each start tag on a new line, optionally indented if an indent step is provided (by default, there is no indentation). If an element contains other elements, the end tag will also appear on a new line with leading indentation. Consider, for example, the following code:

 DataWriter w = new DataWriter();
 w.setIndentStep(2);
 w.startDocument();
 w.startElement("Person");
 w.dataElement("name", "Jane Smith");
 w.dataElement("date-of-birth", "1965-05-23");
 w.dataElement("citizenship", "US");
 w.endElement("Person");
 w.endDocument();
 

This code will produce the following document:

 <?xml version="1.0" standalone="yes"?>
 <Person>
 <name>Jane Smith</name>
 <date-of-birth>1965-05-23</date-of-birth>
 <citizenship>US</citizenship>
 </Person>
 

This class inherits from XMLWriter , and provides all of the same support for Namespaces.


since:
   1.0
author:
   David Megginson, david@megginson.com
version:
   0.2
See Also:   XMLWriter



Constructor Summary
public  DataWriter(Writer writer, String encoding, CharacterEscapeHandler _escapeHandler)
     Create a new data writer for the specified output.
public  DataWriter(Writer writer, String encoding)
    

Method Summary
public  voidcharacters(char ch, int start, int length)
     Write a sequence of characters.
public  voidendDocument()
    
public  voidendElement(String uri, String localName, String qName)
     Write an end tag.
public  intgetIndentStep()
     Return the current indent step.
public  voidreset()
     Reset the writer so that it can be reused.
public  voidsetIndentStep(int indentStep)
     Set the current indent step.
public  voidsetIndentStep(String s)
    
public  voidstartElement(String uri, String localName, String qName, Attributes atts)
     Write a start tag.
protected  voidwriteXmlDecl(String decl)
    


Constructor Detail
DataWriter
public DataWriter(Writer writer, String encoding, CharacterEscapeHandler _escapeHandler)(Code)
Create a new data writer for the specified output.
Parameters:
  writer - The character stream where the XML documentwill be written.
Parameters:
  encoding - If non-null string is specified, it is written as a partof the XML declaration.



DataWriter
public DataWriter(Writer writer, String encoding)(Code)




Method Detail
characters
public void characters(char ch, int start, int length) throws SAXException(Code)
Write a sequence of characters.
Parameters:
  ch - The characters to write.
Parameters:
  start - The starting position in the array.
Parameters:
  length - The number of characters to use.
exception:
  org.xml.sax.SAXException - If there is an errorwriting the characters, or if a filter furtherdown the chain raises an exception.
See Also:   XMLWriter.characters(char[]intint)



endDocument
public void endDocument() throws SAXException(Code)



endElement
public void endElement(String uri, String localName, String qName) throws SAXException(Code)
Write an end tag.

If the element has contained other elements, the tag will appear indented on a new line; otherwise, it will appear immediately following whatever came before.

The newline and indentation will be passed on down the filter chain through regular characters events.


Parameters:
  uri - The element's Namespace URI.
Parameters:
  localName - The element's local name.
Parameters:
  qName - The element's qualified (prefixed) name.
exception:
  org.xml.sax.SAXException - If there is an errorwriting the end tag, or if a filter furtherdown the chain raises an exception.
See Also:   XMLWriter.endElement(StringStringString)



getIndentStep
public int getIndentStep()(Code)
Return the current indent step.

Return the current indent step: each start tag will be indented by this number of spaces times the number of ancestors that the element has.

The number of spaces in each indentation step,or 0 or less for no indentation.
See Also:   DataWriter.setIndentStep(int)



reset
public void reset()(Code)
Reset the writer so that it can be reused.

This method is especially useful if the writer failed with an exception the last time through.


See Also:   XMLWriter.reset



setIndentStep
public void setIndentStep(int indentStep)(Code)
Set the current indent step.
Parameters:
  indentStep - The new indent step (0 or less for noindentation).
See Also:   DataWriter.getIndentStep()



setIndentStep
public void setIndentStep(String s)(Code)



startElement
public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException(Code)
Write a start tag.

Each tag will begin on a new line, and will be indented by the current indent step times the number of ancestors that the element has.

The newline and indentation will be passed on down the filter chain through regular characters events.


Parameters:
  uri - The element's Namespace URI.
Parameters:
  localName - The element's local name.
Parameters:
  qName - The element's qualified (prefixed) name.
Parameters:
  atts - The element's attribute list.
exception:
  org.xml.sax.SAXException - If there is an errorwriting the start tag, or if a filter furtherdown the chain raises an exception.
See Also:   XMLWriter.startElement(StringStringStringAttributes)



writeXmlDecl
protected void writeXmlDecl(String decl) throws IOException(Code)



Methods inherited from com.sun.xml.bind.marshaller.XMLWriter
public void characters(char ch, int start, int len) throws SAXException(Code)(Java Doc)
public void characters(String data) throws SAXException(Code)(Java Doc)
public void dataElement(String uri, String localName, String qName, Attributes atts, String content) throws SAXException(Code)(Java Doc)
public void dataElement(String uri, String localName, String content) throws SAXException(Code)(Java Doc)
public void dataElement(String localName, String content) throws SAXException(Code)(Java Doc)
public void endDocument() throws SAXException(Code)(Java Doc)
public void endElement(String uri, String localName, String qName) throws SAXException(Code)(Java Doc)
public void endElement(String uri, String localName) throws SAXException(Code)(Java Doc)
public void endElement(String localName) throws SAXException(Code)(Java Doc)
public void flush() throws IOException(Code)(Java Doc)
public void ignorableWhitespace(char ch, int start, int length) throws SAXException(Code)(Java Doc)
public void processingInstruction(String target, String data) throws SAXException(Code)(Java Doc)
public void reset()(Code)(Java Doc)
public void setHeader(String _header)(Code)(Java Doc)
public void setOutput(Writer writer, String _encoding)(Code)(Java Doc)
public void setXmlDecl(boolean _writeXmlDecl)(Code)(Java Doc)
public void startDocument() throws SAXException(Code)(Java Doc)
public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException(Code)(Java Doc)
public void startElement(String uri, String localName) throws SAXException(Code)(Java Doc)
public void startElement(String localName) throws SAXException(Code)(Java Doc)
public void startPrefixMapping(String prefix, String uri) throws SAXException(Code)(Java Doc)
final protected void write(char c) throws IOException(Code)(Java Doc)
final protected void write(String s) throws IOException(Code)(Java Doc)
protected void writeXmlDecl(String decl) throws IOException(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.