diff options
| author | Matt Windsor <mattwindsor@btinternet.com> | 2011-03-21 21:54:31 +0000 |
|---|---|---|
| committer | Matt Windsor <mattwindsor@btinternet.com> | 2011-03-21 21:54:31 +0000 |
| commit | df7d7981b56a4560c95ea7e9b194080e93398ecf (patch) | |
| tree | b3ae4f02d23ae1f7f4951c776ee8d91b0047dd6f /doc/uk/org/ury/common/protocol/ProtocolUtils.html | |
| parent | 2d073129857a42ab4195cd433c8be152e357033f (diff) | |
GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh.
Diffstat (limited to 'doc/uk/org/ury/common/protocol/ProtocolUtils.html')
| -rw-r--r-- | doc/uk/org/ury/common/protocol/ProtocolUtils.html | 322 |
1 files changed, 322 insertions, 0 deletions
diff --git a/doc/uk/org/ury/common/protocol/ProtocolUtils.html b/doc/uk/org/ury/common/protocol/ProtocolUtils.html new file mode 100644 index 0000000..4eec6b3 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/ProtocolUtils.html @@ -0,0 +1,322 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_20) on Mon Mar 21 21:53:07 GMT 2011 --> +<TITLE> +ProtocolUtils +</TITLE> + +<META NAME="date" CONTENT="2011-03-21"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ProtocolUtils"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProtocolUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../uk/org/ury/common/protocol/Directive.html" title="enum in uk.org.ury.common.protocol"><B>PREV CLASS</B></A> + <A HREF="../../../../../uk/org/ury/common/protocol/Status.html" title="enum in uk.org.ury.common.protocol"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?uk/org/ury/common/protocol/ProtocolUtils.html" target="_top"><B>FRAMES</B></A> + <A HREF="ProtocolUtils.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +uk.org.ury.common.protocol</FONT> +<BR> +Class ProtocolUtils</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>uk.org.ury.common.protocol.ProtocolUtils</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>ProtocolUtils</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +Utilities for converting between strings encoded in the response protocol and + collections of items, as well as validating and unpicking protocol messages. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Matt Windsor</DD> +</DL> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../uk/org/ury/common/protocol/ProtocolUtils.html#ProtocolUtils()">ProtocolUtils</A></B>()</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.util.Map<?,?></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> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../uk/org/ury/common/protocol/ProtocolUtils.html#encode(java.util.Map)">encode</A></B>(java.util.Map<java.lang.String,java.lang.Object> items)</CODE> + +<BR> + Encode a key-value map into a protocol string.</TD> +</TR> +<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> + +<BR> + Check if a response is flagged as having OK status.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="ProtocolUtils()"><!-- --></A><H3> +ProtocolUtils</H3> +<PRE> +public <B>ProtocolUtils</B>()</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<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> +<DL> +<DD>Encode a key-value map into a protocol string. + + The map can contain strings, lists and other maps. Other types may be + accepted by the underlying encoding engine, but the above types are the + only ones explicitly accepted. +<P> +<DD><DL> +<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> +</DD> +</DL> +<HR> + +<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> +<DL> +<DD>Decode 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> +</DL> +<HR> + +<A NAME="responseIsOK(java.util.Map)"><!-- --></A><H3> +responseIsOK</H3> +<PRE> +public static boolean <B>responseIsOK</B>(java.util.Map<?,?> 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. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>response</CODE> - The response message, as a key-value map (eg in decoded + format). +<DT><B>Returns:</B><DD>true if the response is flagged with OK status, false if not (eg + ERROR status). +<DT><B>Throws:</B> +<DD><CODE><A HREF="../../../../../uk/org/ury/common/protocol/exceptions/InvalidMessageException.html" title="class in uk.org.ury.common.protocol.exceptions">InvalidMessageException</A></CODE> - if the response is invalid (eg the status is missing).</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProtocolUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../uk/org/ury/common/protocol/Directive.html" title="enum in uk.org.ury.common.protocol"><B>PREV CLASS</B></A> + <A HREF="../../../../../uk/org/ury/common/protocol/Status.html" title="enum in uk.org.ury.common.protocol"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?uk/org/ury/common/protocol/ProtocolUtils.html" target="_top"><B>FRAMES</B></A> + <A HREF="ProtocolUtils.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |