Java Doc for XMLEvent.java in  » 6.0-JDK-Modules » jsr173-Stax » javax » xml » stream » events » 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.events 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.xml.stream.events.XMLEvent

XMLEvent
public interface XMLEvent extends javax.xml.stream.XMLStreamConstants(Code)
This is the base event interface for handling markup events. Events are value objects that are used to communicate the XML 1.0 InfoSet to the Application. Events may be cached and referenced after the parse has completed.
version:
   1.0
author:
   Copyright (c) 2003 by BEA Systems. All Rights Reserved.
See Also:   javax.xml.stream.XMLEventReader
See Also:   Characters
See Also:   ProcessingInstruction
See Also:   StartElement
See Also:   EndElement
See Also:   StartDocument
See Also:   EndDocument
See Also:   EntityReference
See Also:   EntityDeclaration
See Also:   NotationDeclaration




Method Summary
public  CharactersasCharacters()
     Returns this event as Characters, may result in a class cast exception if this event is not Characters.
public  EndElementasEndElement()
     Returns this event as an end element event, may result in a class cast exception if this event is not a end element.
public  StartElementasStartElement()
     Returns this event as a start element event, may result in a class cast exception if this event is not a start element.
public  intgetEventType()
     Returns an integer code for this event.
 javax.xml.stream.LocationgetLocation()
     Return the location of this event.
public  QNamegetSchemaType()
     This method is provided for implementations to provide optional type information about the associated event.
public  booleanisAttribute()
     A utility function to check if this event is an Attribute.
public  booleanisCharacters()
     A utility function to check if this event is Characters.
public  booleanisEndDocument()
     A utility function to check if this event is an EndDocument.
public  booleanisEndElement()
     A utility function to check if this event is a EndElement.
public  booleanisEntityReference()
     A utility function to check if this event is an EntityReference.
public  booleanisNamespace()
     A utility function to check if this event is a Namespace.
public  booleanisProcessingInstruction()
     A utility function to check if this event is a ProcessingInstruction.
public  booleanisStartDocument()
     A utility function to check if this event is a StartDocument.
public  booleanisStartElement()
     A utility function to check if this event is a StartElement.
public  voidwriteAsEncodedUnicode(Writer writer)
     This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. No indentation or whitespace should be outputted. Any user defined event type SHALL have this method called when being written to on an output stream. Built in Event types MUST implement this method, but implementations MAY choose not call these methods for optimizations reasons when writing out built in Events to an output stream.



Method Detail
asCharacters
public Characters asCharacters()(Code)
Returns this event as Characters, may result in a class cast exception if this event is not Characters.



asEndElement
public EndElement asEndElement()(Code)
Returns this event as an end element event, may result in a class cast exception if this event is not a end element.



asStartElement
public StartElement asStartElement()(Code)
Returns this event as a start element event, may result in a class cast exception if this event is not a start element.



getEventType
public int getEventType()(Code)
Returns an integer code for this event.
See Also:   XMLEvent.START_ELEMENT
See Also:   XMLEvent.END_ELEMENT
See Also:   XMLEvent.CHARACTERS
See Also:   XMLEvent.ATTRIBUTE
See Also:   XMLEvent.NAMESPACE
See Also:   XMLEvent.PROCESSING_INSTRUCTION
See Also:   XMLEvent.COMMENT
See Also:   XMLEvent.START_DOCUMENT
See Also:   XMLEvent.END_DOCUMENT
See Also:   XMLEvent.DTD



getLocation
javax.xml.stream.Location getLocation()(Code)
Return the location of this event. The Location returned from this method is non-volatile and will retain its information.
See Also:   javax.xml.stream.Location



getSchemaType
public QName getSchemaType()(Code)
This method is provided for implementations to provide optional type information about the associated event. It is optional and will return null if no information is available.



isAttribute
public boolean isAttribute()(Code)
A utility function to check if this event is an Attribute.
See Also:   Attribute



isCharacters
public boolean isCharacters()(Code)
A utility function to check if this event is Characters.
See Also:   Characters



isEndDocument
public boolean isEndDocument()(Code)
A utility function to check if this event is an EndDocument.
See Also:   EndDocument



isEndElement
public boolean isEndElement()(Code)
A utility function to check if this event is a EndElement.
See Also:   EndElement



isEntityReference
public boolean isEntityReference()(Code)
A utility function to check if this event is an EntityReference.
See Also:   EntityReference



isNamespace
public boolean isNamespace()(Code)
A utility function to check if this event is a Namespace.
See Also:   Namespace



isProcessingInstruction
public boolean isProcessingInstruction()(Code)
A utility function to check if this event is a ProcessingInstruction.
See Also:   ProcessingInstruction



isStartDocument
public boolean isStartDocument()(Code)
A utility function to check if this event is a StartDocument.
See Also:   StartDocument



isStartElement
public boolean isStartElement()(Code)
A utility function to check if this event is a StartElement.
See Also:   StartElement



writeAsEncodedUnicode
public void writeAsEncodedUnicode(Writer writer) throws javax.xml.stream.XMLStreamException(Code)
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. No indentation or whitespace should be outputted. Any user defined event type SHALL have this method called when being written to on an output stream. Built in Event types MUST implement this method, but implementations MAY choose not call these methods for optimizations reasons when writing out built in Events to an output stream. The output generated MUST be equivalent in terms of the infoset expressed.
Parameters:
  writer - The writer that will output the data
throws:
  XMLStreamException - if there is a fatal error writing the event



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