Package org.gjt.xpp
Class XmlPullParserFactory
java.lang.Object
org.gjt.xpp.XmlPullParserFactory
This class is used to create implementations of XML Pull Parser.
Based on JAXP ideas but tailored to work in J2ME environments
(no access to system properties or file system).
- Author:
- Aleksander Slominski
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Proteted constructor to be called by factory implementations. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates whether or not the factory is configured to produce parsers which are namespace aware.Create new end tag.Return new XML formatter.static XmlPullParserFactory
Get a new instance of a PullParserFactory used to create XPP.static XmlPullParserFactory
newInstance
(Class classLoaderCtx) Get a new instance of a PullParserFactory used to create XPP.static XmlPullParserFactory
newInstance
(String factoryClassName) Get a new instance of a PullParserFactory from given class name.newNode()
Return new XML node.newNode
(XmlPullParser pp) Return new XML node that is represeting tree from current pull parser start tag.Return new XML pull node that is represeting tree from current pull parser start tag.Create new XML pull parser.Return new XML recorder.Return new XML start tag.Equivalent to calling readNode(reader, false);Read XmlNode from input - essentially it is utility function that will create instance of pull parser, feed input inpt it and return new node tree parsed form the input.void
setNamespaceAware
(boolean awareness) Specifies that the parser produced by this factory will provide support for XML namespaces.void
Equivalent to calling writeNode(node, writer, false);void
-
Field Details
-
DEFAULT_PROPERTY_NAME
- See Also:
-
-
Constructor Details
-
XmlPullParserFactory
protected XmlPullParserFactory()Proteted constructor to be called by factory implementations.
-
-
Method Details
-
newInstance
Get a new instance of a PullParserFactory used to create XPP.- Throws:
XmlPullParserException
-
newInstance
public static XmlPullParserFactory newInstance(String factoryClassName) throws XmlPullParserException Get a new instance of a PullParserFactory from given class name.- Parameters:
factoryClassName
- use specified factory class if not null- Throws:
XmlPullParserException
-
newInstance
Get a new instance of a PullParserFactory used to create XPP.NOTE: passing classLoaderCtx is not very useful in ME but can be useful in container environment where multiple class loaders are used (it is using Class as ClassLoader is not in ME profile).
- Parameters:
classLoaderCtx
- if not null it is used to find default factory and to create instance- Throws:
XmlPullParserException
-
setNamespaceAware
Specifies that the parser produced by this factory will provide support for XML namespaces. By default the value of this is set to false.- Parameters:
awareness
- true if the parser produced by this code will provide support for XML namespaces; false otherwise.- Throws:
XmlPullParserException
-
isNamespaceAware
public boolean isNamespaceAware()Indicates whether or not the factory is configured to produce parsers which are namespace aware.- Returns:
- true if the factory is configured to produce parsers which are namespace aware; false otherwise.
-
newPullParser
Create new XML pull parser.- Throws:
XmlPullParserException
-
newEndTag
Create new end tag.- Throws:
XmlPullParserException
-
newNode
Return new XML node.- Throws:
XmlPullParserException
-
newNode
Return new XML node that is represeting tree from current pull parser start tag.- Throws:
XmlPullParserException
IOException
-
newPullNode
Return new XML pull node that is represeting tree from current pull parser start tag.- Throws:
XmlPullParserException
-
newStartTag
Return new XML start tag.- Throws:
XmlPullParserException
-
newFormatter
Return new XML formatter.- Throws:
XmlPullParserException
-
newRecorder
Return new XML recorder.- Throws:
XmlPullParserException
-
readNode
public XmlNode readNode(Reader reader, boolean closeAtEnd) throws XmlPullParserException, IOException Read XmlNode from input - essentially it is utility function that will create instance of pull parser, feed input inpt it and return new node tree parsed form the input. If closeAtEnd is true clos() will be called on reader- Throws:
XmlPullParserException
IOException
-
readNode
Equivalent to calling readNode(reader, false);- Throws:
XmlPullParserException
IOException
-
writeNode
public void writeNode(XmlNode node, Writer writer, boolean closeAtEnd) throws XmlPullParserException, IOException - Throws:
XmlPullParserException
IOException
-
writeNode
Equivalent to calling writeNode(node, writer, false);- Throws:
XmlPullParserException
IOException
-