Package com.google.api.client.xml
Class XmlObjectParser
- java.lang.Object
-
- com.google.api.client.xml.XmlObjectParser
-
- All Implemented Interfaces:
ObjectParser
@Beta public class XmlObjectParser extends java.lang.Object implements ObjectParser
Beta
XML HTTP parser into an data class of key/value pairs.Implementation is thread-safe.
Sample usage:
static void setParser(HttpRequest request, XmlNamespaceDictionary namespaceDictionary) { request.setParser(new XmlObjectParser(namespaceDictionary)); }
- Since:
- 1.10
-
-
Field Summary
Fields Modifier and Type Field Description private XmlNamespaceDictionary
namespaceDictionary
XML namespace dictionary.
-
Constructor Summary
Constructors Constructor Description XmlObjectParser(XmlNamespaceDictionary namespaceDictionary)
Creates an XmlObjectParser using the specified non-null namespace dictionary.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description XmlNamespaceDictionary
getNamespaceDictionary()
Returns the XML namespace dictionary.<T> T
parseAndClose(java.io.InputStream in, java.nio.charset.Charset charset, java.lang.Class<T> dataClass)
Parses the given input stream into a new instance of the the given data class of key/value pairs and closes the input stream.java.lang.Object
parseAndClose(java.io.InputStream in, java.nio.charset.Charset charset, java.lang.reflect.Type dataType)
Parses the given input stream into a new instance of the the given data type of key/value pairs and closes the input stream.<T> T
parseAndClose(java.io.Reader reader, java.lang.Class<T> dataClass)
Parses the given reader into a new instance of the the given data class of key/value pairs and closes the reader.java.lang.Object
parseAndClose(java.io.Reader reader, java.lang.reflect.Type dataType)
Parses the given reader into a new instance of the the given data type of key/value pairs and closes the reader.private java.lang.Object
readObject(org.xmlpull.v1.XmlPullParser parser, java.lang.reflect.Type dataType)
-
-
-
Field Detail
-
namespaceDictionary
private final XmlNamespaceDictionary namespaceDictionary
XML namespace dictionary.
-
-
Constructor Detail
-
XmlObjectParser
public XmlObjectParser(XmlNamespaceDictionary namespaceDictionary)
Creates an XmlObjectParser using the specified non-null namespace dictionary.- Parameters:
namespaceDictionary
- XML namespace dictionary
-
-
Method Detail
-
getNamespaceDictionary
public final XmlNamespaceDictionary getNamespaceDictionary()
Returns the XML namespace dictionary.
-
readObject
private java.lang.Object readObject(org.xmlpull.v1.XmlPullParser parser, java.lang.reflect.Type dataType) throws org.xmlpull.v1.XmlPullParserException, java.io.IOException
- Throws:
org.xmlpull.v1.XmlPullParserException
java.io.IOException
-
parseAndClose
public <T> T parseAndClose(java.io.InputStream in, java.nio.charset.Charset charset, java.lang.Class<T> dataClass) throws java.io.IOException
Description copied from interface:ObjectParser
Parses the given input stream into a new instance of the the given data class of key/value pairs and closes the input stream.- Specified by:
parseAndClose
in interfaceObjectParser
- Parameters:
in
- input stream which contains the data to parsecharset
- charset which should be used to decode the input stream ornull
if unknowndataClass
- class into which the data is parsed- Throws:
java.io.IOException
-
parseAndClose
public java.lang.Object parseAndClose(java.io.InputStream in, java.nio.charset.Charset charset, java.lang.reflect.Type dataType) throws java.io.IOException
Description copied from interface:ObjectParser
Parses the given input stream into a new instance of the the given data type of key/value pairs and closes the input stream.- Specified by:
parseAndClose
in interfaceObjectParser
- Parameters:
in
- input stream which contains the data to parsecharset
- charset which should be used to decode the input stream ornull
if unknowndataType
- type into which the data is parsed- Throws:
java.io.IOException
-
parseAndClose
public <T> T parseAndClose(java.io.Reader reader, java.lang.Class<T> dataClass) throws java.io.IOException
Description copied from interface:ObjectParser
Parses the given reader into a new instance of the the given data class of key/value pairs and closes the reader.- Specified by:
parseAndClose
in interfaceObjectParser
- Parameters:
reader
- reader which contains the text data to parsedataClass
- class into which the data is parsed- Throws:
java.io.IOException
-
parseAndClose
public java.lang.Object parseAndClose(java.io.Reader reader, java.lang.reflect.Type dataType) throws java.io.IOException
Description copied from interface:ObjectParser
Parses the given reader into a new instance of the the given data type of key/value pairs and closes the reader.- Specified by:
parseAndClose
in interfaceObjectParser
- Parameters:
reader
- reader which contains the text data to parsedataType
- type into which the data is parsed- Throws:
java.io.IOException
-
-