mirrors/public-transport-enabler
1
0
Fork 0
mirror of https://gitlab.com/oeffi/public-transport-enabler.git synced 2025-07-13 08:10:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

final cosmetics

Browse source 
git-svn-id: https://public-transport-enabler.googlecode.com/svn/trunk@210 0924bc21-9374-b0fa-ee44-9ff1593b38f0
This commit is contained in:
andreas.schildbach 2010-09-30 11:07:44 +00:00
parent abb935cf6d
commit 3cd0bf957d
1 changed files with 40 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

85
src/de/schildbach/pte/util/XmlPullUtil.java
View file

@ -17,18 +17,14 @@ import org.xmlpull.v1.XmlSerializer;
* @author <a href="http://www.extreme.indiana.edu/~aslom/">Aleksander Slominski</a> * @author <a href="http://www.extreme.indiana.edu/~aslom/">Aleksander Slominski</a>
* @author Naresh Bhatia * @author Naresh Bhatia
*/ */
public class XmlPullUtil public final class XmlPullUtil
{ {
public static final String XSI_NS = "http://www.w3.org/2001/XMLSchema-instance"; public static final String XSI_NS = "http://www.w3.org/2001/XMLSchema-instance";
private XmlPullUtil()
{
}
/** /**
* Return value of attribute with given name and no namespace. * Return value of attribute with given name and no namespace.
*/ */
public static String getAttributeValue(XmlPullParser pp, String name) public static String getAttributeValue(final XmlPullParser pp, final String name)
{ {
return pp.getAttributeValue(XmlPullParser.NO_NAMESPACE, name); return pp.getAttributeValue(XmlPullParser.NO_NAMESPACE, name);
} }
@ -36,7 +32,7 @@ public class XmlPullUtil
/** /**
* Return PITarget from Processing Instruction (PI) as defined in XML 1.0 Section 2.6 Processing Instructions <code>[16] PI ::= '&lt;?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'</code> * Return PITarget from Processing Instruction (PI) as defined in XML 1.0 Section 2.6 Processing Instructions <code>[16] PI ::= '&lt;?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'</code>
*/ */
public static String getPITarget(XmlPullParser pp) throws IllegalStateException public static String getPITarget(final XmlPullParser pp) throws IllegalStateException
{ {
int eventType; int eventType;
@ -44,10 +40,10 @@ public class XmlPullUtil
{ {
eventType = pp.getEventType(); eventType = pp.getEventType();
} }
catch (XmlPullParserException ex) catch (final XmlPullParserException x)
{ {
// should never happen ... // should never happen ...
throw new IllegalStateException("could not determine parser state: " + ex + pp.getPositionDescription()); throw new IllegalStateException("could not determine parser state: " + x + pp.getPositionDescription());
} }
if (eventType != XmlPullParser.PROCESSING_INSTRUCTION) if (eventType != XmlPullParser.PROCESSING_INSTRUCTION)
@ -63,6 +59,7 @@ public class XmlPullUtil
return PI.substring(0, i); return PI.substring(0, i);
} }
} }
return PI; return PI;
} }
@ -73,17 +70,18 @@ public class XmlPullUtil
* <p> * <p>
* <b>NOTE:</b> if there is no PI data it returns empty string. * <b>NOTE:</b> if there is no PI data it returns empty string.
*/ */
public static String getPIData(XmlPullParser pp) throws IllegalStateException public static String getPIData(final XmlPullParser pp) throws IllegalStateException
{ {
int eventType; int eventType;
try try
{ {
eventType = pp.getEventType(); eventType = pp.getEventType();
} }
catch (XmlPullParserException ex) catch (final XmlPullParserException x)
{ {
// should never happen ... // should never happen ...
throw new IllegalStateException("could not determine parser state: " + ex + pp.getPositionDescription()); throw new IllegalStateException("could not determine parser state: " + x + pp.getPositionDescription());
} }
if (eventType != XmlPullParser.PROCESSING_INSTRUCTION) if (eventType != XmlPullParser.PROCESSING_INSTRUCTION)
@ -103,13 +101,14 @@ public class XmlPullUtil
return PI.substring(i); return PI.substring(i);
} }
} }
return ""; return "";
} }
/** /**
* Return true if chacters is S as defined in XML 1.0 <code>S ::= (#x20 | #x9 | #xD | #xA)+</code> * Return true if chacters is S as defined in XML 1.0 <code>S ::= (#x20 | #x9 | #xD | #xA)+</code>
*/ */
private static boolean isS(char ch) private static boolean isS(final char ch)
{ {
return (ch == ' ' || ch == '\n' || ch == '\r' || ch == '\t'); return (ch == ' ' || ch == '\n' || ch == '\r' || ch == '\t');
} }
@ -118,14 +117,14 @@ public class XmlPullUtil
* Skip sub tree that is currently porser positioned on. <br> * Skip sub tree that is currently porser positioned on. <br>
* NOTE: parser must be on START_TAG and when funtion returns parser will be positioned on corresponding END_TAG * NOTE: parser must be on START_TAG and when funtion returns parser will be positioned on corresponding END_TAG
*/ */
public static void skipSubTree(XmlPullParser pp) throws XmlPullParserException, IOException public static void skipSubTree(final XmlPullParser pp) throws XmlPullParserException, IOException
{ {
pp.require(XmlPullParser.START_TAG, null, null); pp.require(XmlPullParser.START_TAG, null, null);
int level = 1; int level = 1;
while (level > 0) while (level > 0)
{ {
int eventType = pp.next(); final int eventType = pp.next();
if (eventType == XmlPullParser.END_TAG) if (eventType == XmlPullParser.END_TAG)
--level; --level;
else if (eventType == XmlPullParser.START_TAG) else if (eventType == XmlPullParser.START_TAG)
@ -136,7 +135,7 @@ public class XmlPullUtil
/** /**
* call parser nextTag() and check that it is START_TAG, throw exception if not. * call parser nextTag() and check that it is START_TAG, throw exception if not.
*/ */
public static void nextStartTag(XmlPullParser pp) throws XmlPullParserException, IOException public static void nextStartTag(final XmlPullParser pp) throws XmlPullParserException, IOException
{ {
if (pp.nextTag() != XmlPullParser.START_TAG) if (pp.nextTag() != XmlPullParser.START_TAG)
throw new XmlPullParserException("expected START_TAG and not " + pp.getPositionDescription()); throw new XmlPullParserException("expected START_TAG and not " + pp.getPositionDescription());
@ -145,7 +144,7 @@ public class XmlPullUtil
/** /**
* combine nextTag(); pp.require(XmlPullParser.START_TAG, null, name); * combine nextTag(); pp.require(XmlPullParser.START_TAG, null, name);
*/ */
public static void nextStartTag(XmlPullParser pp, String name) throws XmlPullParserException, IOException public static void nextStartTag(final XmlPullParser pp, final String name) throws XmlPullParserException, IOException
{ {
pp.nextTag(); pp.nextTag();
pp.require(XmlPullParser.START_TAG, null, name); pp.require(XmlPullParser.START_TAG, null, name);
@ -154,7 +153,7 @@ public class XmlPullUtil
/** /**
* combine nextTag(); pp.require(XmlPullParser.START_TAG, namespace, name); * combine nextTag(); pp.require(XmlPullParser.START_TAG, namespace, name);
*/ */
public static void nextStartTag(XmlPullParser pp, String namespace, String name) throws XmlPullParserException, IOException public static void nextStartTag(final XmlPullParser pp, final String namespace, final String name) throws XmlPullParserException, IOException
{ {
pp.nextTag(); pp.nextTag();
pp.require(XmlPullParser.START_TAG, namespace, name); pp.require(XmlPullParser.START_TAG, namespace, name);
@ -163,7 +162,7 @@ public class XmlPullUtil
/** /**
* combine nextTag(); pp.require(XmlPullParser.END_TAG, namespace, name); * combine nextTag(); pp.require(XmlPullParser.END_TAG, namespace, name);
*/ */
public static void nextEndTag(XmlPullParser pp, String namespace, String name) throws XmlPullParserException, IOException public static void nextEndTag(final XmlPullParser pp, final String namespace, final String name) throws XmlPullParserException, IOException
{ {
pp.nextTag(); pp.nextTag();
pp.require(XmlPullParser.END_TAG, namespace, name); pp.require(XmlPullParser.END_TAG, namespace, name);
@ -174,7 +173,7 @@ public class XmlPullUtil
* not be checked) * not be checked)
*/ */
public static String nextText(XmlPullParser pp, String namespace, String name) throws IOException, XmlPullParserException public static String nextText(final XmlPullParser pp, final String namespace, final String name) throws IOException, XmlPullParserException
{ {
if (name == null) if (name == null)
throw new XmlPullParserException("name for element can not be null"); throw new XmlPullParserException("name for element can not be null");
@ -187,7 +186,8 @@ public class XmlPullUtil
* Read attribute value and return it or throw exception if current element does not have such attribute. * Read attribute value and return it or throw exception if current element does not have such attribute.
*/ */
public static String getRequiredAttributeValue(XmlPullParser pp, String namespace, String name) throws IOException, XmlPullParserException public static String getRequiredAttributeValue(final XmlPullParser pp, final String namespace, final String name) throws IOException,
XmlPullParserException
{ {
final String value = pp.getAttributeValue(namespace, name); final String value = pp.getAttributeValue(namespace, name);
if (value == null) if (value == null)
@ -199,7 +199,7 @@ public class XmlPullUtil
/** /**
* Call parser nextTag() and check that it is END_TAG, throw exception if not. * Call parser nextTag() and check that it is END_TAG, throw exception if not.
*/ */
public static void nextEndTag(XmlPullParser pp) throws XmlPullParserException, IOException public static void nextEndTag(final XmlPullParser pp) throws XmlPullParserException, IOException
{ {
if (pp.nextTag() != XmlPullParser.END_TAG) if (pp.nextTag() != XmlPullParser.END_TAG)
throw new XmlPullParserException("expected END_TAG and not" + pp.getPositionDescription()); throw new XmlPullParserException("expected END_TAG and not" + pp.getPositionDescription());
@ -209,7 +209,7 @@ public class XmlPullUtil
* Tests if the current event is of the given type and if the namespace and name match. null will match any * Tests if the current event is of the given type and if the namespace and name match. null will match any
* namespace and any name. If the test passes a true is returned otherwise a false is returned. * namespace and any name. If the test passes a true is returned otherwise a false is returned.
*/ */
public static boolean matches(XmlPullParser pp, int type, String namespace, String name) throws XmlPullParserException public static boolean matches(final XmlPullParser pp, final int type, final String namespace, final String name) throws XmlPullParserException
{ {
boolean matches = type == pp.getEventType() && (namespace == null || namespace.equals(pp.getNamespace())) boolean matches = type == pp.getEventType() && (namespace == null || namespace.equals(pp.getNamespace()))
&& (name == null || name.equals(pp.getName())); && (name == null || name.equals(pp.getName()));
@ -221,21 +221,17 @@ public class XmlPullUtil
* Writes a simple element such as <username>johndoe</username>. The namespace and elementText are allowed to be * Writes a simple element such as <username>johndoe</username>. The namespace and elementText are allowed to be
* null. If elementText is null, an xsi:nil="true" will be added as an attribute. * null. If elementText is null, an xsi:nil="true" will be added as an attribute.
*/ */
public static void writeSimpleElement(XmlSerializer serializer, String namespace, String elementName, String elementText) throws IOException, public static void writeSimpleElement(final XmlSerializer serializer, final String namespace, final String elementName, final String elementText)
XmlPullParserException throws IOException, XmlPullParserException
{ {
if (elementName == null) if (elementName == null)
throw new XmlPullParserException("name for element can not be null"); throw new XmlPullParserException("name for element can not be null");
serializer.startTag(namespace, elementName); serializer.startTag(namespace, elementName);
if (elementText == null) if (elementText == null)
{
serializer.attribute(XSI_NS, "nil", "true"); serializer.attribute(XSI_NS, "nil", "true");
}
else else
{
serializer.text(elementText); serializer.text(elementText);
}
serializer.endTag(namespace, elementName); serializer.endTag(namespace, elementName);
} }
@ -249,7 +245,7 @@ public class XmlPullUtil
while (true) while (true)
{ {
int eventType = pp.next(); final int eventType = pp.next();
if (eventType == XmlPullParser.START_TAG) if (eventType == XmlPullParser.START_TAG)
{ {
skipSubTree(pp); skipSubTree(pp);
@ -277,19 +273,19 @@ public class XmlPullUtil
throw new IllegalArgumentException("namespace and name argument can not be both null:" + pp.getPositionDescription()); throw new IllegalArgumentException("namespace and name argument can not be both null:" + pp.getPositionDescription());
pp.require(XmlPullParser.START_TAG, null, null); pp.require(XmlPullParser.START_TAG, null, null);
while (true) while (true)
{ {
int eventType = pp.next(); final int eventType = pp.next();
if (eventType == XmlPullParser.START_TAG) if (eventType == XmlPullParser.START_TAG)
{ {
String name = pp.getName(); final String name = pp.getName();
String namespace = pp.getNamespace(); final String namespace = pp.getNamespace();
boolean matches = (tagNamespace != null && tagNamespace.equals(namespace)) || (tagName != null && tagName.equals(name)); boolean matches = (tagNamespace != null && tagNamespace.equals(namespace)) || (tagName != null && tagName.equals(name));
if (matches) if (matches)
{
return true; return true;
}
skipSubTree(pp); skipSubTree(pp);
pp.require(XmlPullParser.END_TAG, name, namespace); pp.require(XmlPullParser.END_TAG, name, namespace);
pp.next(); // skip end tag pp.next(); // skip end tag
@ -315,16 +311,16 @@ public class XmlPullUtil
while (true) while (true)
{ {
int eventType = pp.next(); final int eventType = pp.next();
if (eventType == XmlPullParser.START_TAG) if (eventType == XmlPullParser.START_TAG)
{ {
String name = pp.getName(); final String name = pp.getName();
String namespace = pp.getNamespace(); final String namespace = pp.getNamespace();
boolean matches = (tagNamespace != null && tagNamespace.equals(namespace)) || (tagName != null && tagName.equals(name)); boolean matches = (tagNamespace != null && tagNamespace.equals(namespace)) || (tagName != null && tagName.equals(name));
if (matches) if (matches)
{
return true; return true;
}
} }
else if (eventType == XmlPullParser.END_DOCUMENT) else if (eventType == XmlPullParser.END_DOCUMENT)
{ {
@ -347,16 +343,15 @@ public class XmlPullUtil
while (true) while (true)
{ {
int eventType = pp.next(); final int eventType = pp.next();
if (eventType == XmlPullParser.END_TAG) if (eventType == XmlPullParser.END_TAG)
{ {
String name = pp.getName(); final String name = pp.getName();
String namespace = pp.getNamespace(); final String namespace = pp.getNamespace();
boolean matches = (tagNamespace != null && tagNamespace.equals(namespace)) || (tagName != null && tagName.equals(name)); boolean matches = (tagNamespace != null && tagNamespace.equals(namespace)) || (tagName != null && tagName.equals(name));
if (matches) if (matches)
{
return true; return true;
}
} }
else if (eventType == XmlPullParser.END_DOCUMENT) else if (eventType == XmlPullParser.END_DOCUMENT)
{ {