Java Doc for XMLInputFactory.java in  » 6.0-JDK-Core » xml » javax » xml » stream » 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   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    javax.xml.stream.XMLInputFactory XMLInputFactory abstract public class XMLInputFactory (Code) Defines an abstract implementation of a factory for getting streams. The following table defines the standard properties of this specification. Each property varies in the level of support required by each implementation. The level of support required is described in the 'Required' column. Configuration parameters Property Name Behavior Return type Default Value Required javax.xml.stream.isValidating Turns on/off implementation specific DTD validation Boolean False No javax.xml.stream.isNamespaceAware Turns on/off namespace processing for XML 1.0 support Boolean True True (required) / False (optional) javax.xml.stream.isCoalescing Requires the processor to coalesce adjacent character data Boolean False Yes javax.xml.stream.isReplacingEntityReferences replace internal entity references with their replacement text and report them as characters Boolean True Yes javax.xml.stream.isSupportingExternalEntities Resolve external parsed entities Boolean Unspecified Yes javax.xml.stream.supportDTD Use this property to request processors that do not support DTDs Boolean True Yes javax.xml.stream.reporter sets/gets the impl of the XMLReporter javax.xml.stream.XMLReporter Null Yes javax.xml.stream.resolver sets/gets the impl of the XMLResolver interface javax.xml.stream.XMLResolver Null Yes javax.xml.stream.allocator sets/gets the impl of the XMLEventAllocator interface javax.xml.stream.util.XMLEventAllocator Null Yes version:    1.0 author:    Copyright (c) 2003 by BEA Systems. All Rights Reserved. See Also:   XMLOutputFactory See Also:   XMLEventReader See Also:   XMLStreamReader See Also:   EventFilter See Also:   XMLReporter See Also:   XMLResolver See Also:   javax.xml.stream.util.XMLEventAllocator since:    1.6 Field Summary final public static  String ALLOCATOR      final public static  String IS_COALESCING      final public static  String IS_NAMESPACE_AWARE      final public static  String IS_REPLACING_ENTITY_REFERENCES      final public static  String IS_SUPPORTING_EXTERNAL_ENTITIES      final public static  String IS_VALIDATING      final public static  String REPORTER      final public static  String RESOLVER      final public static  String SUPPORT_DTD      Constructor Summary protected   XMLInputFactory()      Method Summary abstract public  XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter)      abstract public  XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter)      abstract public  XMLEventReader createXMLEventReader(java.io.Reader reader)      abstract public  XMLEventReader createXMLEventReader(String systemId, java.io.Reader reader)      abstract public  XMLEventReader createXMLEventReader(XMLStreamReader reader)      Create a new XMLEventReader from an XMLStreamReader. abstract public  XMLEventReader createXMLEventReader(Source source)      Create a new XMLEventReader from a JAXP source. abstract public  XMLEventReader createXMLEventReader(java.io.InputStream stream)      abstract public  XMLEventReader createXMLEventReader(java.io.InputStream stream, String encoding)      abstract public  XMLEventReader createXMLEventReader(String systemId, java.io.InputStream stream)      abstract public  XMLStreamReader createXMLStreamReader(java.io.Reader reader)      abstract public  XMLStreamReader createXMLStreamReader(Source source)      Create a new XMLStreamReader from a JAXP source. abstract public  XMLStreamReader createXMLStreamReader(java.io.InputStream stream)      abstract public  XMLStreamReader createXMLStreamReader(java.io.InputStream stream, String encoding)      abstract public  XMLStreamReader createXMLStreamReader(String systemId, java.io.InputStream stream)      abstract public  XMLStreamReader createXMLStreamReader(String systemId, java.io.Reader reader)      abstract public  XMLEventAllocator getEventAllocator()      abstract public  Object getProperty(java.lang.String name)      abstract public  XMLReporter getXMLReporter()      The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. abstract public  XMLResolver getXMLResolver()      The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. abstract public  boolean isPropertySupported(String name)      Query the set of properties that this factory supports. public static  XMLInputFactory newInstance()      Create a new instance of the factory. This static method creates a new factory instance. public static  XMLInputFactory newInstance(String factoryId, ClassLoader classLoader)      abstract public  void setEventAllocator(XMLEventAllocator allocator)      abstract public  void setProperty(java.lang.String name, Object value)      Allows the user to set specific feature/property on the underlying implementation. abstract public  void setXMLReporter(XMLReporter reporter)      The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. abstract public  void setXMLResolver(XMLResolver resolver)      The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. Field Detail ALLOCATOR final public static String ALLOCATOR(Code) The property used to set/get the implementation of the allocator IS_COALESCING final public static String IS_COALESCING(Code) The property that requires the parser to coalesce adjacent character data sections IS_NAMESPACE_AWARE final public static String IS_NAMESPACE_AWARE(Code) The property used to turn on/off namespace support, this is to support XML 1.0 documents, only the true setting must be supported IS_REPLACING_ENTITY_REFERENCES final public static String IS_REPLACING_ENTITY_REFERENCES(Code) Requires the parser to replace internal entity references with their replacement text and report them as characters IS_SUPPORTING_EXTERNAL_ENTITIES final public static String IS_SUPPORTING_EXTERNAL_ENTITIES(Code) The property that requires the parser to resolve external parsed entities IS_VALIDATING final public static String IS_VALIDATING(Code) The property used to turn on/off implementation specific validation REPORTER final public static String REPORTER(Code) The property used to set/get the implementation of the XMLReporter interface RESOLVER final public static String RESOLVER(Code) The property used to set/get the implementation of the XMLResolver SUPPORT_DTD final public static String SUPPORT_DTD(Code) The property that requires the parser to support DTDs Constructor Detail XMLInputFactory protected XMLInputFactory()(Code) Method Detail createFilteredReader abstract public XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter) throws XMLStreamException(Code) Create a filtered reader that wraps the filter around the reader Parameters:   reader - the reader to filter Parameters:   filter - the filter to apply to the reader throws:   XMLStreamException - createFilteredReader abstract public XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter) throws XMLStreamException(Code) Create a filtered event reader that wraps the filter around the event reader Parameters:   reader - the event reader to wrap Parameters:   filter - the filter to apply to the event reader throws:   XMLStreamException - createXMLEventReader abstract public XMLEventReader createXMLEventReader(java.io.Reader reader) throws XMLStreamException(Code) Create a new XMLEventReader from a reader Parameters:   reader - the XML data to read from throws:   XMLStreamException - createXMLEventReader abstract public XMLEventReader createXMLEventReader(String systemId, java.io.Reader reader) throws XMLStreamException(Code) Create a new XMLEventReader from a reader Parameters:   systemId - the system ID of the input Parameters:   reader - the XML data to read from throws:   XMLStreamException - createXMLEventReader abstract public XMLEventReader createXMLEventReader(XMLStreamReader reader) throws XMLStreamException(Code) Create a new XMLEventReader from an XMLStreamReader. After being used to construct the XMLEventReader instance returned from this method the XMLStreamReader must not be used. Parameters:   reader - the XMLStreamReader to read from (may not be modified) a new XMLEventReader throws:   XMLStreamException - createXMLEventReader abstract public XMLEventReader createXMLEventReader(Source source) throws XMLStreamException(Code) Create a new XMLEventReader from a JAXP source. Support of this method is optional. Parameters:   source - the source to read from throws:   UnsupportedOperationException - if this method is not supported by this XMLInputFactory createXMLEventReader abstract public XMLEventReader createXMLEventReader(java.io.InputStream stream) throws XMLStreamException(Code) Create a new XMLEventReader from a java.io.InputStream Parameters:   stream - the InputStream to read from throws:   XMLStreamException - createXMLEventReader abstract public XMLEventReader createXMLEventReader(java.io.InputStream stream, String encoding) throws XMLStreamException(Code) Create a new XMLEventReader from a java.io.InputStream Parameters:   stream - the InputStream to read from Parameters:   encoding - the character encoding of the stream throws:   XMLStreamException - createXMLEventReader abstract public XMLEventReader createXMLEventReader(String systemId, java.io.InputStream stream) throws XMLStreamException(Code) Create a new XMLEventReader from a java.io.InputStream Parameters:   systemId - the system ID of the stream Parameters:   stream - the InputStream to read from throws:   XMLStreamException - createXMLStreamReader abstract public XMLStreamReader createXMLStreamReader(java.io.Reader reader) throws XMLStreamException(Code) Create a new XMLStreamReader from a reader Parameters:   reader - the XML data to read from throws:   XMLStreamException - createXMLStreamReader abstract public XMLStreamReader createXMLStreamReader(Source source) throws XMLStreamException(Code) Create a new XMLStreamReader from a JAXP source. This method is optional. Parameters:   source - the source to read from throws:   UnsupportedOperationException - if this method is not supported by this XMLInputFactory throws:   XMLStreamException - createXMLStreamReader abstract public XMLStreamReader createXMLStreamReader(java.io.InputStream stream) throws XMLStreamException(Code) Create a new XMLStreamReader from a java.io.InputStream Parameters:   stream - the InputStream to read from throws:   XMLStreamException - createXMLStreamReader abstract public XMLStreamReader createXMLStreamReader(java.io.InputStream stream, String encoding) throws XMLStreamException(Code) Create a new XMLStreamReader from a java.io.InputStream Parameters:   stream - the InputStream to read from Parameters:   encoding - the character encoding of the stream throws:   XMLStreamException - createXMLStreamReader abstract public XMLStreamReader createXMLStreamReader(String systemId, java.io.InputStream stream) throws XMLStreamException(Code) Create a new XMLStreamReader from a java.io.InputStream Parameters:   systemId - the system ID of the stream Parameters:   stream - the InputStream to read from createXMLStreamReader abstract public XMLStreamReader createXMLStreamReader(String systemId, java.io.Reader reader) throws XMLStreamException(Code) Create a new XMLStreamReader from a java.io.InputStream Parameters:   systemId - the system ID of the stream Parameters:   reader - the InputStream to read from getEventAllocator abstract public XMLEventAllocator getEventAllocator()(Code) Gets the allocator used by streams created with this factory getProperty abstract public Object getProperty(java.lang.String name) throws java.lang.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 getXMLReporter abstract public XMLReporter getXMLReporter()(Code) The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. getXMLResolver abstract public XMLResolver getXMLResolver()(Code) The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. isPropertySupported abstract public boolean isPropertySupported(String name)(Code) Query the set of properties that this factory supports. Parameters:   name - The name of the property (may not be null) true if the property is supported and false otherwise newInstance public static XMLInputFactory newInstance() throws FactoryConfigurationError(Code) Create a new instance of the factory. This static method creates a new factory instance. This method uses the following ordered lookup procedure to determine the XMLInputFactory implementation class to load: Use the javax.xml.stream.XMLInputFactory system property. Use the properties file "lib/stax.properties" in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above. Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.stream.XMLInputFactory in jars available to the runtime. Platform default XMLInputFactory instance. Once an application has obtained a reference to a XMLInputFactory it can use the factory to configure and obtain stream instances. throws:   FactoryConfigurationError - if an instance of this factory cannot be loaded newInstance public static XMLInputFactory newInstance(String factoryId, ClassLoader classLoader) throws FactoryConfigurationError(Code) Create a new instance of the factory Parameters:   factoryId - Name of the factory to find, same asa property name Parameters:   classLoader - classLoader to use the factory implementation throws:   FactoryConfigurationError - if an instance of this factory cannot be loaded setEventAllocator abstract public void setEventAllocator(XMLEventAllocator allocator)(Code) Set a user defined event allocator for events Parameters:   allocator - the user defined allocator setProperty abstract public void setProperty(java.lang.String name, Object value) throws java.lang.IllegalArgumentException(Code) Allows the user to set specific feature/property on the underlying implementation. The underlying implementation is not required to support every setting of every property in the specification and may use IllegalArgumentException to signal that an unsupported property may not be set with the specified value. Parameters:   name - The name of the property (may not be null) Parameters:   value - The value of the property throws:   java.lang.IllegalArgumentException - if the property is not supported setXMLReporter abstract public void setXMLReporter(XMLReporter reporter)(Code) The reporter that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. Parameters:   reporter - the resolver to use to report non fatal errors setXMLResolver abstract public void setXMLResolver(XMLResolver resolver)(Code) The resolver that will be set on any XMLStreamReader or XMLEventReader created by this factory instance. Parameters:   resolver - the resolver to use to resolve references 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)