diff options
Diffstat (limited to 'doc/uk/org/ury/common/protocol/ProtocolUtils.html')
| -rw-r--r-- | doc/uk/org/ury/common/protocol/ProtocolUtils.html | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/doc/uk/org/ury/common/protocol/ProtocolUtils.html b/doc/uk/org/ury/common/protocol/ProtocolUtils.html index 204f4e2..05de494 100644 --- a/doc/uk/org/ury/common/protocol/ProtocolUtils.html +++ b/doc/uk/org/ury/common/protocol/ProtocolUtils.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_20) on Wed Mar 23 13:20:47 GMT 2011 --> +<!-- Generated by javadoc (build 1.6.0_20) on Thu Mar 24 14:42:43 GMT 2011 --> <TITLE> ProtocolUtils </TITLE> -<META NAME="date" CONTENT="2011-03-23"> +<META NAME="date" CONTENT="2011-03-24"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> @@ -140,11 +140,11 @@ Utilities for converting between strings encoded in the response protocol and </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static java.util.Map<?,?></CODE></FONT></TD> +<CODE>static java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../uk/org/ury/common/protocol/ProtocolUtils.html#decode(java.lang.String)">decode</A></B>(java.lang.String string)</CODE> <BR> - Decode a protocol string into a key-value map.</TD> + Decodes a protocol string into a key-value map.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -157,10 +157,10 @@ Utilities for converting between strings encoded in the response protocol and <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../../uk/org/ury/common/protocol/ProtocolUtils.html#responseIsOK(java.util.Map)">responseIsOK</A></B>(java.util.Map<?,?> response)</CODE> +<TD><CODE><B><A HREF="../../../../../uk/org/ury/common/protocol/ProtocolUtils.html#responseIsOK(java.util.Map)">responseIsOK</A></B>(java.util.Map<java.lang.String,java.lang.Object> response)</CODE> <BR> - Check if a response is flagged as having OK status.</TD> + Checks if a response is flagged as having OK status.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> @@ -205,7 +205,8 @@ public <B>ProtocolUtils</B>()</PRE> <A NAME="encode(java.util.Map)"><!-- --></A><H3> encode</H3> <PRE> -public static java.lang.String <B>encode</B>(java.util.Map<java.lang.String,java.lang.Object> items)</PRE> +public static java.lang.String <B>encode</B>(java.util.Map<java.lang.String,java.lang.Object> items) + throws <A HREF="../../../../../uk/org/ury/common/protocol/exceptions/EncodeFailureException.html" title="class in uk.org.ury.common.protocol.exceptions">EncodeFailureException</A></PRE> <DL> <DD>Encode a key-value map into a protocol string. @@ -217,7 +218,9 @@ public static java.lang.String <B>encode</B>(java.util.Map<java.lang.String,j <DT><B>Parameters:</B><DD><CODE>items</CODE> - The key-value map of items, which should contain strings, lists and maps. The keys of any map should be protocol directives. -<DT><B>Returns:</B><DD>A string containing the encoded representation of the map.</DL> +<DT><B>Returns:</B><DD>A string containing the encoded representation of the map. +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../uk/org/ury/common/protocol/exceptions/EncodeFailureException.html" title="class in uk.org.ury.common.protocol.exceptions">EncodeFailureException</A></CODE> - if the encoding engine fails to encode the map as a string.</DL> </DD> </DL> <HR> @@ -225,16 +228,16 @@ public static java.lang.String <B>encode</B>(java.util.Map<java.lang.String,j <A NAME="decode(java.lang.String)"><!-- --></A><H3> decode</H3> <PRE> -public static java.util.Map<?,?> <B>decode</B>(java.lang.String string) - throws <A HREF="../../../../../uk/org/ury/common/protocol/exceptions/DecodeFailureException.html" title="class in uk.org.ury.common.protocol.exceptions">DecodeFailureException</A></PRE> +public static java.util.Map<java.lang.String,java.lang.Object> <B>decode</B>(java.lang.String string) + throws <A HREF="../../../../../uk/org/ury/common/protocol/exceptions/DecodeFailureException.html" title="class in uk.org.ury.common.protocol.exceptions">DecodeFailureException</A></PRE> <DL> -<DD>Decode a protocol string into a key-value map. +<DD>Decodes a protocol string into a key-value map. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>string</CODE> - The string to decode. <DT><B>Returns:</B><DD>A key-value map mapping directives to strings, lists and maps. <DT><B>Throws:</B> -<DD><CODE><A HREF="../../../../../uk/org/ury/common/protocol/exceptions/DecodeFailureException.html" title="class in uk.org.ury.common.protocol.exceptions">DecodeFailureException</A></CODE> - if the decoding engine returns something other than a map.</DL> +<DD><CODE><A HREF="../../../../../uk/org/ury/common/protocol/exceptions/DecodeFailureException.html" title="class in uk.org.ury.common.protocol.exceptions">DecodeFailureException</A></CODE> - if the decoding engine fails to decode the string.</DL> </DD> </DL> <HR> @@ -242,10 +245,10 @@ public static java.util.Map<?,?> <B>decode</B>(java.lang.String strin <A NAME="responseIsOK(java.util.Map)"><!-- --></A><H3> responseIsOK</H3> <PRE> -public static boolean <B>responseIsOK</B>(java.util.Map<?,?> response) +public static boolean <B>responseIsOK</B>(java.util.Map<java.lang.String,java.lang.Object> response) throws <A HREF="../../../../../uk/org/ury/common/protocol/exceptions/InvalidMessageException.html" title="class in uk.org.ury.common.protocol.exceptions">InvalidMessageException</A></PRE> <DL> -<DD>Check if a response is flagged as having OK status. +<DD>Checks if a response is flagged as having OK status. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>response</CODE> - The response message, as a key-value map (eg in decoded |