fr.liglab.adele.icasa.common.xml.utils

Class XMLUtils

java.lang.Object

fr.liglab.adele.icasa.common.xml.utils.XMLUtils

public class XMLUtils
extends Object

Some XML helpers methods. This code comes from the Android source code.

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	beginDocument(org.xmlpull.v1.XmlPullParser parser, String firstElementName)
static boolean	convertValueToBoolean(CharSequence value, boolean defaultValue)
static int	convertValueToInt(CharSequence charSeq, int defaultValue)
static int	convertValueToList(CharSequence value, String[] options, int defaultValue)
static int	convertValueToUnsignedInt(String value, int defaultValue)
static void	nextElement(org.xmlpull.v1.XmlPullParser parser)
static int	parseUnsignedIntAttribute(CharSequence charSeq)
static ArrayList	readListXml(InputStream in) Read an ArrayList from an InputStream containing XML.
static Map<String,Object>	readMapXml(InputStream in) Read a HashMap from an InputStream containing XML.
static int[]	readThisIntArrayXml(org.xmlpull.v1.XmlPullParser parser, String endTag, String[] name) Read an int[] object from an XmlPullParser.
static ArrayList	readThisListXml(org.xmlpull.v1.XmlPullParser parser, String endTag, String[] name) Read an ArrayList object from an XmlPullParser.
static HashMap	readThisMapXml(org.xmlpull.v1.XmlPullParser parser, String endTag, String[] name) Read a HashMap object from an XmlPullParser.
static Object	readValueXml(org.xmlpull.v1.XmlPullParser parser, String[] name) Read a flattened object from an XmlPullParser.
static void	skipCurrentTag(org.xmlpull.v1.XmlPullParser parser)
static void	writeByteArrayXml(byte[] val, String name, org.xmlpull.v1.XmlSerializer out) Flatten a byte[] into an XmlSerializer.
static void	writeIntArrayXml(int[] val, String name, org.xmlpull.v1.XmlSerializer out) Flatten an int[] into an XmlSerializer.
static void	writeListXml(List val, OutputStream out) Flatten a List into an output stream as XML.
static void	writeListXml(List val, String name, org.xmlpull.v1.XmlSerializer out) Flatten a List into an XmlSerializer.
static void	writeMapXml(Map val, OutputStream out) Flatten a Map into an output stream as XML.
static void	writeMapXml(Map val, String name, org.xmlpull.v1.XmlSerializer out) Flatten a Map into an XmlSerializer.
static void	writeValueXml(Object v, String name, org.xmlpull.v1.XmlSerializer out) Flatten an object's value into an XmlSerializer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

skipCurrentTag

public static void skipCurrentTag(org.xmlpull.v1.XmlPullParser parser)
                           throws org.xmlpull.v1.XmlPullParserException,
                                  IOException

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

convertValueToList

public static final int convertValueToList(CharSequence value,
                     String[] options,
                     int defaultValue)

convertValueToBoolean

public static final boolean convertValueToBoolean(CharSequence value,
                            boolean defaultValue)

convertValueToInt

public static final int convertValueToInt(CharSequence charSeq,
                    int defaultValue)

convertValueToUnsignedInt

public static final int convertValueToUnsignedInt(String value,
                            int defaultValue)

parseUnsignedIntAttribute

public static final int parseUnsignedIntAttribute(CharSequence charSeq)

writeMapXml

public static final void writeMapXml(Map val,
               OutputStream out)
                              throws org.xmlpull.v1.XmlPullParserException,
                                     IOException

Flatten a Map into an output stream as XML. The map can later be read back with readMapXml().

Parameters:

val - The map to be flattened.

out - Where to write the XML data.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

writeMapXml(java.util.Map, String, XmlSerializer), writeListXml(java.util.List, java.io.OutputStream), writeValueXml(java.lang.Object, java.lang.String, org.xmlpull.v1.XmlSerializer), readMapXml(java.io.InputStream)

writeListXml

public static final void writeListXml(List val,
                OutputStream out)
                               throws org.xmlpull.v1.XmlPullParserException,
                                      IOException

Flatten a List into an output stream as XML. The list can later be read back with readListXml().

Parameters:

val - The list to be flattened.

out - Where to write the XML data.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

writeListXml(java.util.List, String, XmlSerializer), writeMapXml(java.util.Map, java.io.OutputStream), writeValueXml(java.lang.Object, java.lang.String, org.xmlpull.v1.XmlSerializer), readListXml(java.io.InputStream)

writeMapXml

public static final void writeMapXml(Map val,
               String name,
               org.xmlpull.v1.XmlSerializer out)
                              throws org.xmlpull.v1.XmlPullParserException,
                                     IOException

Flatten a Map into an XmlSerializer. The map can later be read back with readThisMapXml().

Parameters:

val - The map to be flattened.

name - Name attribute to include with this list's tag, or null for none.

out - XmlSerializer to write the map into.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

writeMapXml(java.util.Map, java.io.OutputStream), writeListXml(java.util.List, java.io.OutputStream), writeValueXml(java.lang.Object, java.lang.String, org.xmlpull.v1.XmlSerializer), readMapXml(java.io.InputStream)

writeListXml

public static final void writeListXml(List val,
                String name,
                org.xmlpull.v1.XmlSerializer out)
                               throws org.xmlpull.v1.XmlPullParserException,
                                      IOException

Flatten a List into an XmlSerializer. The list can later be read back with readThisListXml().

Parameters:

val - The list to be flattened.

name - Name attribute to include with this list's tag, or null for none.

out - XmlSerializer to write the list into.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

writeListXml(java.util.List, java.io.OutputStream), writeMapXml(java.util.Map, java.io.OutputStream), writeValueXml(java.lang.Object, java.lang.String, org.xmlpull.v1.XmlSerializer), readListXml(java.io.InputStream)

writeByteArrayXml

public static final void writeByteArrayXml(byte[] val,
                     String name,
                     org.xmlpull.v1.XmlSerializer out)
                                    throws org.xmlpull.v1.XmlPullParserException,
                                           IOException

Flatten a byte[] into an XmlSerializer. The list can later be read back with readThisByteArrayXml().

Parameters:

val - The byte array to be flattened.

name - Name attribute to include with this array's tag, or null for none.

out - XmlSerializer to write the array into.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

writeMapXml(java.util.Map, java.io.OutputStream), writeValueXml(java.lang.Object, java.lang.String, org.xmlpull.v1.XmlSerializer)

writeIntArrayXml

public static final void writeIntArrayXml(int[] val,
                    String name,
                    org.xmlpull.v1.XmlSerializer out)
                                   throws org.xmlpull.v1.XmlPullParserException,
                                          IOException

Flatten an int[] into an XmlSerializer. The list can later be read back with readThisIntArrayXml().

Parameters:

val - The int array to be flattened.

name - Name attribute to include with this array's tag, or null for none.

out - XmlSerializer to write the array into.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

writeMapXml(java.util.Map, java.io.OutputStream), writeValueXml(java.lang.Object, java.lang.String, org.xmlpull.v1.XmlSerializer), readThisIntArrayXml(org.xmlpull.v1.XmlPullParser, java.lang.String, java.lang.String[])

writeValueXml

public static final void writeValueXml(Object v,
                 String name,
                 org.xmlpull.v1.XmlSerializer out)
                                throws org.xmlpull.v1.XmlPullParserException,
                                       IOException

Flatten an object's value into an XmlSerializer. The value can later be read back with readThisValueXml(). Currently supported value types are: null, String, Integer, Long, Float, Double Boolean, Map, List.

Parameters:

v - The object to be flattened.

name - Name attribute to include with this value's tag, or null for none.

out - XmlSerializer to write the object into.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

writeMapXml(java.util.Map, java.io.OutputStream), writeListXml(java.util.List, java.io.OutputStream), readValueXml(org.xmlpull.v1.XmlPullParser, java.lang.String[])

readMapXml

public static final Map<String,Object> readMapXml(InputStream in)
                                           throws org.xmlpull.v1.XmlPullParserException,
                                                  IOException

Read a HashMap from an InputStream containing XML. The stream can previously have been written by writeMapXml().

Parameters:

in - The InputStream from which to read.

Returns:

HashMap The resulting map.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

readListXml(java.io.InputStream), readValueXml(org.xmlpull.v1.XmlPullParser, java.lang.String[]), #see #writeMapXml

readListXml

public static final ArrayList readListXml(InputStream in)
                                   throws org.xmlpull.v1.XmlPullParserException,
                                          IOException

Read an ArrayList from an InputStream containing XML. The stream can previously have been written by writeListXml().

Parameters:

in - The InputStream from which to read.

Returns:

HashMap The resulting list.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

readMapXml(java.io.InputStream), readValueXml(org.xmlpull.v1.XmlPullParser, java.lang.String[]), readThisListXml(org.xmlpull.v1.XmlPullParser, java.lang.String, java.lang.String[]), writeListXml(java.util.List, java.io.OutputStream)

readThisMapXml

public static final HashMap readThisMapXml(org.xmlpull.v1.XmlPullParser parser,
                     String endTag,
                     String[] name)
                                    throws org.xmlpull.v1.XmlPullParserException,
                                           IOException

Read a HashMap object from an XmlPullParser. The XML data could previously have been generated by writeMapXml(). The XmlPullParser must be positioned after the tag that begins the map.

Parameters:

parser - The XmlPullParser from which to read the map data.

endTag - Name of the tag that will end the map, usually "map".

name - An array of one string, used to return the name attribute of the map's tag.

Returns:

HashMap The newly generated map.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

readMapXml(java.io.InputStream)

readThisListXml

public static final ArrayList readThisListXml(org.xmlpull.v1.XmlPullParser parser,
                        String endTag,
                        String[] name)
                                       throws org.xmlpull.v1.XmlPullParserException,
                                              IOException

Read an ArrayList object from an XmlPullParser. The XML data could previously have been generated by writeListXml(). The XmlPullParser must be positioned after the tag that begins the list.

Parameters:

parser - The XmlPullParser from which to read the list data.

endTag - Name of the tag that will end the list, usually "list".

name - An array of one string, used to return the name attribute of the list's tag.

Returns:

HashMap The newly generated list.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

readListXml(java.io.InputStream)

readThisIntArrayXml

public static final int[] readThisIntArrayXml(org.xmlpull.v1.XmlPullParser parser,
                        String endTag,
                        String[] name)
                                       throws org.xmlpull.v1.XmlPullParserException,
                                              IOException

Read an int[] object from an XmlPullParser. The XML data could previously have been generated by writeIntArrayXml(). The XmlPullParser must be positioned after the tag that begins the list.

Parameters:

parser - The XmlPullParser from which to read the list data.

endTag - Name of the tag that will end the list, usually "list".

name - An array of one string, used to return the name attribute of the list's tag.

Returns:

Returns a newly generated int[].

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

readListXml(java.io.InputStream)

readValueXml

public static final Object readValueXml(org.xmlpull.v1.XmlPullParser parser,
                  String[] name)
                                 throws org.xmlpull.v1.XmlPullParserException,
                                        IOException

Read a flattened object from an XmlPullParser. The XML data could previously have been written with writeMapXml(), writeListXml(), or writeValueXml(). The XmlPullParser must be positioned at the tag that defines the value.

Parameters:

parser - The XmlPullParser from which to read the object.

name - An array of one string, used to return the name attribute of the value's tag.

Returns:

Object The newly generated value object.

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

See Also:

readMapXml(java.io.InputStream), readListXml(java.io.InputStream), writeValueXml(java.lang.Object, java.lang.String, org.xmlpull.v1.XmlSerializer)

beginDocument

public static final void beginDocument(org.xmlpull.v1.XmlPullParser parser,
                 String firstElementName)
                                throws org.xmlpull.v1.XmlPullParserException,
                                       IOException

Throws:

org.xmlpull.v1.XmlPullParserException

IOException

nextElement

public static final void nextElement(org.xmlpull.v1.XmlPullParser parser)
                              throws org.xmlpull.v1.XmlPullParserException,
                                     IOException

Throws:

org.xmlpull.v1.XmlPullParserException

IOException