Java Doc for XMLEvent.java in  » 6.0-JDK-Core » xml » javax » xml » stream » events » 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.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
since:
   1.6




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.