From df7d7981b56a4560c95ea7e9b194080e93398ecf Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 21:54:31 +0000 Subject: GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh. --- doc/uk/org/ury/common/protocol/Directive.html | 362 +++++++++++++++++++++ doc/uk/org/ury/common/protocol/ProtocolUtils.html | 322 ++++++++++++++++++ doc/uk/org/ury/common/protocol/Status.html | 330 +++++++++++++++++++ .../ury/common/protocol/class-use/Directive.html | 189 +++++++++++ .../common/protocol/class-use/ProtocolUtils.html | 144 ++++++++ .../org/ury/common/protocol/class-use/Status.html | 189 +++++++++++ .../exceptions/DecodeFailureException.html | 250 ++++++++++++++ .../exceptions/InvalidMessageException.html | 251 ++++++++++++++ .../class-use/DecodeFailureException.html | 209 ++++++++++++ .../class-use/InvalidMessageException.html | 209 ++++++++++++ .../common/protocol/exceptions/package-frame.html | 34 ++ .../protocol/exceptions/package-summary.html | 162 +++++++++ .../common/protocol/exceptions/package-tree.html | 158 +++++++++ .../common/protocol/exceptions/package-use.html | 216 ++++++++++++ doc/uk/org/ury/common/protocol/package-frame.html | 45 +++ .../org/ury/common/protocol/package-summary.html | 176 ++++++++++ doc/uk/org/ury/common/protocol/package-tree.html | 163 ++++++++++ doc/uk/org/ury/common/protocol/package-use.html | 176 ++++++++++ 18 files changed, 3585 insertions(+) create mode 100644 doc/uk/org/ury/common/protocol/Directive.html create mode 100644 doc/uk/org/ury/common/protocol/ProtocolUtils.html create mode 100644 doc/uk/org/ury/common/protocol/Status.html create mode 100644 doc/uk/org/ury/common/protocol/class-use/Directive.html create mode 100644 doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html create mode 100644 doc/uk/org/ury/common/protocol/class-use/Status.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/InvalidMessageException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/class-use/InvalidMessageException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/package-use.html create mode 100644 doc/uk/org/ury/common/protocol/package-frame.html create mode 100644 doc/uk/org/ury/common/protocol/package-summary.html create mode 100644 doc/uk/org/ury/common/protocol/package-tree.html create mode 100644 doc/uk/org/ury/common/protocol/package-use.html (limited to 'doc/uk/org/ury/common/protocol') diff --git a/doc/uk/org/ury/common/protocol/Directive.html b/doc/uk/org/ury/common/protocol/Directive.html new file mode 100644 index 0000000..7ec7a46 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/Directive.html @@ -0,0 +1,362 @@ + + + + + + +Directive + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +uk.org.ury.common.protocol +
+Enum Directive

+
+java.lang.Object
+  extended by java.lang.Enum<Directive>
+      extended by uk.org.ury.common.protocol.Directive
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Directive>
+
+
+
+
public enum Directive
extends java.lang.Enum<Directive>
+ + +

+Directives supported by the protocol. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
INFO + +
+           
ITEMS + +
+           
REASON + +
+           
STATUS + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static DirectivevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static Directive[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+INFO

+
+public static final Directive INFO
+
+
+
+
+
+ +

+ITEMS

+
+public static final Directive ITEMS
+
+
+
+
+
+ +

+STATUS

+
+public static final Directive STATUS
+
+
+
+
+
+ +

+REASON

+
+public static final Directive REASON
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Directive[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Directive c : Directive.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Directive valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + 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 @@ + + + + + + +ProtocolUtils + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.common.protocol +
+Class ProtocolUtils

+
+java.lang.Object
+  extended by uk.org.ury.common.protocol.ProtocolUtils
+
+
+
+
public class ProtocolUtils
extends java.lang.Object
+ + +

+Utilities for converting between strings encoded in the response protocol and + collections of items, as well as validating and unpicking protocol messages. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
ProtocolUtils() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static java.util.Map<?,?>decode(java.lang.String string) + +
+          Decode a protocol string into a key-value map.
+static java.lang.Stringencode(java.util.Map<java.lang.String,java.lang.Object> items) + +
+          Encode a key-value map into a protocol string.
+static booleanresponseIsOK(java.util.Map<?,?> response) + +
+          Check if a response is flagged as having OK status.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ProtocolUtils

+
+public ProtocolUtils()
+
+
+ + + + + + + + +
+Method Detail
+ +

+encode

+
+public static java.lang.String encode(java.util.Map<java.lang.String,java.lang.Object> items)
+
+
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. +

+

+
Parameters:
items - The key-value map of items, which should contain strings, + lists and maps. The keys of any map should be protocol + directives. +
Returns:
A string containing the encoded representation of the map.
+
+
+
+ +

+decode

+
+public static java.util.Map<?,?> decode(java.lang.String string)
+                                 throws DecodeFailureException
+
+
Decode a protocol string into a key-value map. +

+

+
Parameters:
string - The string to decode. +
Returns:
A key-value map mapping directives to strings, lists and maps. +
Throws: +
DecodeFailureException - if the decoding engine returns something other than a map.
+
+
+
+ +

+responseIsOK

+
+public static boolean responseIsOK(java.util.Map<?,?> response)
+                            throws InvalidMessageException
+
+
Check if a response is flagged as having OK status. +

+

+
Parameters:
response - The response message, as a key-value map (eg in decoded + format). +
Returns:
true if the response is flagged with OK status, false if not (eg + ERROR status). +
Throws: +
InvalidMessageException - if the response is invalid (eg the status is missing).
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/Status.html b/doc/uk/org/ury/common/protocol/Status.html new file mode 100644 index 0000000..8ec2dc4 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/Status.html @@ -0,0 +1,330 @@ + + + + + + +Status + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +uk.org.ury.common.protocol +
+Enum Status

+
+java.lang.Object
+  extended by java.lang.Enum<Status>
+      extended by uk.org.ury.common.protocol.Status
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Status>
+
+
+
+
public enum Status
extends java.lang.Enum<Status>
+ + +

+Statuses that can follow the STATUS directory. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + + + +
+Enum Constant Summary
ERROR + +
+           
OK + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static StatusvalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static Status[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+OK

+
+public static final Status OK
+
+
+
+
+
+ +

+ERROR

+
+public static final Status ERROR
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Status[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Status c : Status.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Status valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/class-use/Directive.html b/doc/uk/org/ury/common/protocol/class-use/Directive.html new file mode 100644 index 0000000..74dabe8 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/class-use/Directive.html @@ -0,0 +1,189 @@ + + + + + + +Uses of Class uk.org.ury.common.protocol.Directive + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.common.protocol.Directive

+
+ + + + + + + + + +
+Packages that use Directive
uk.org.ury.common.protocol  
+  +

+ + + + + +
+Uses of Directive in uk.org.ury.common.protocol
+  +

+ + + + + + + + + + + + + +
Methods in uk.org.ury.common.protocol that return Directive
+static DirectiveDirective.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static Directive[]Directive.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html b/doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html new file mode 100644 index 0000000..dba6942 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.common.protocol.ProtocolUtils + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.common.protocol.ProtocolUtils

+
+No usage of uk.org.ury.common.protocol.ProtocolUtils +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/class-use/Status.html b/doc/uk/org/ury/common/protocol/class-use/Status.html new file mode 100644 index 0000000..431d76a --- /dev/null +++ b/doc/uk/org/ury/common/protocol/class-use/Status.html @@ -0,0 +1,189 @@ + + + + + + +Uses of Class uk.org.ury.common.protocol.Status + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.common.protocol.Status

+
+ + + + + + + + + +
+Packages that use Status
uk.org.ury.common.protocol  
+  +

+ + + + + +
+Uses of Status in uk.org.ury.common.protocol
+  +

+ + + + + + + + + + + + + +
Methods in uk.org.ury.common.protocol that return Status
+static StatusStatus.valueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static Status[]Status.values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html b/doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html new file mode 100644 index 0000000..cc41139 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html @@ -0,0 +1,250 @@ + + + + + + +DecodeFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.common.protocol.exceptions +
+Class DecodeFailureException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.common.protocol.exceptions.DecodeFailureException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class DecodeFailureException
extends java.lang.Exception
+ + +

+Exception thrown when the protocol decoder fails. +

+ +

+

+
Author:
+
Matt Windsor
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
DecodeFailureException(java.lang.String reason) + +
+          Construct a new DecodeFailureException with a reason.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+DecodeFailureException

+
+public DecodeFailureException(java.lang.String reason)
+
+
Construct a new DecodeFailureException with a reason. +

+

+
Parameters:
reason - The reason for throwing the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/exceptions/InvalidMessageException.html b/doc/uk/org/ury/common/protocol/exceptions/InvalidMessageException.html new file mode 100644 index 0000000..5c4ebca --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/InvalidMessageException.html @@ -0,0 +1,251 @@ + + + + + + +InvalidMessageException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.common.protocol.exceptions +
+Class InvalidMessageException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.common.protocol.exceptions.InvalidMessageException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class InvalidMessageException
extends java.lang.Exception
+ + +

+Generic exception thrown when a protocol function cannot process a + message due to an issue with the message. +

+ +

+

+
Author:
+
Matt Windsor
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
InvalidMessageException(java.lang.String reason) + +
+          Construct a new InvalidMessageException with a reason.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+InvalidMessageException

+
+public InvalidMessageException(java.lang.String reason)
+
+
Construct a new InvalidMessageException with a reason. +

+

+
Parameters:
reason - The reason for throwing the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html b/doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html new file mode 100644 index 0000000..ed7efdd --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.common.protocol.exceptions.DecodeFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.common.protocol.exceptions.DecodeFailureException

+
+ + + + + + + + + + + + + +
+Packages that use DecodeFailureException
uk.org.ury.common.protocol  
uk.org.ury.frontend.client  
+  +

+ + + + + +
+Uses of DecodeFailureException in uk.org.ury.common.protocol
+  +

+ + + + + + + + + +
Methods in uk.org.ury.common.protocol that throw DecodeFailureException
+static java.util.Map<?,?>ProtocolUtils.decode(java.lang.String string) + +
+          Decode a protocol string into a key-value map.
+  +

+ + + + + +
+Uses of DecodeFailureException in uk.org.ury.frontend.client
+  +

+ + + + + + + + + +
Methods in uk.org.ury.frontend.client that throw DecodeFailureException
+ java.util.Map<?,?>Client.get(java.lang.String file) + +
+          Get a raw response from the server.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/exceptions/class-use/InvalidMessageException.html b/doc/uk/org/ury/common/protocol/exceptions/class-use/InvalidMessageException.html new file mode 100644 index 0000000..429b125 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/class-use/InvalidMessageException.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.common.protocol.exceptions.InvalidMessageException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.common.protocol.exceptions.InvalidMessageException

+
+ + + + + + + + + + + + + +
+Packages that use InvalidMessageException
uk.org.ury.common.protocol  
uk.org.ury.frontend.modules.library  
+  +

+ + + + + +
+Uses of InvalidMessageException in uk.org.ury.common.protocol
+  +

+ + + + + + + + + +
Methods in uk.org.ury.common.protocol that throw InvalidMessageException
+static booleanProtocolUtils.responseIsOK(java.util.Map<?,?> response) + +
+          Check if a response is flagged as having OK status.
+  +

+ + + + + +
+Uses of InvalidMessageException in uk.org.ury.frontend.modules.library
+  +

+ + + + + + + + + +
Methods in uk.org.ury.frontend.modules.library that throw InvalidMessageException
+ voidLibraryViewer.doSearch(java.lang.String search) + +
+          Does a library search.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/exceptions/package-frame.html b/doc/uk/org/ury/common/protocol/exceptions/package-frame.html new file mode 100644 index 0000000..8ca3aa8 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +uk.org.ury.common.protocol.exceptions + + + + + + + + + + + +uk.org.ury.common.protocol.exceptions + + + + +
+Exceptions  + +
+DecodeFailureException +
+InvalidMessageException
+ + + + diff --git a/doc/uk/org/ury/common/protocol/exceptions/package-summary.html b/doc/uk/org/ury/common/protocol/exceptions/package-summary.html new file mode 100644 index 0000000..2d42276 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/package-summary.html @@ -0,0 +1,162 @@ + + + + + + +uk.org.ury.common.protocol.exceptions + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.common.protocol.exceptions +

+ + + + + + + + + + + + + +
+Exception Summary
DecodeFailureExceptionException thrown when the protocol decoder fails.
InvalidMessageExceptionGeneric exception thrown when a protocol function cannot process a + message due to an issue with the message.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/exceptions/package-tree.html b/doc/uk/org/ury/common/protocol/exceptions/package-tree.html new file mode 100644 index 0000000..9599133 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +uk.org.ury.common.protocol.exceptions Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.common.protocol.exceptions +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/exceptions/package-use.html b/doc/uk/org/ury/common/protocol/exceptions/package-use.html new file mode 100644 index 0000000..81062e4 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/package-use.html @@ -0,0 +1,216 @@ + + + + + + +Uses of Package uk.org.ury.common.protocol.exceptions + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
uk.org.ury.common.protocol.exceptions

+
+ + + + + + + + + + + + + + + + + +
+Packages that use uk.org.ury.common.protocol.exceptions
uk.org.ury.common.protocol  
uk.org.ury.frontend.client  
uk.org.ury.frontend.modules.library  
+  +

+ + + + + + + + + + + +
+Classes in uk.org.ury.common.protocol.exceptions used by uk.org.ury.common.protocol
DecodeFailureException + +
+          Exception thrown when the protocol decoder fails.
InvalidMessageException + +
+          Generic exception thrown when a protocol function cannot process a + message due to an issue with the message.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.common.protocol.exceptions used by uk.org.ury.frontend.client
DecodeFailureException + +
+          Exception thrown when the protocol decoder fails.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.common.protocol.exceptions used by uk.org.ury.frontend.modules.library
InvalidMessageException + +
+          Generic exception thrown when a protocol function cannot process a + message due to an issue with the message.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/package-frame.html b/doc/uk/org/ury/common/protocol/package-frame.html new file mode 100644 index 0000000..8ea297f --- /dev/null +++ b/doc/uk/org/ury/common/protocol/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +uk.org.ury.common.protocol + + + + + + + + + + + +uk.org.ury.common.protocol + + + + +
+Classes  + +
+ProtocolUtils
+ + + + + + +
+Enums  + +
+Directive +
+Status
+ + + + diff --git a/doc/uk/org/ury/common/protocol/package-summary.html b/doc/uk/org/ury/common/protocol/package-summary.html new file mode 100644 index 0000000..e53976c --- /dev/null +++ b/doc/uk/org/ury/common/protocol/package-summary.html @@ -0,0 +1,176 @@ + + + + + + +uk.org.ury.common.protocol + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.common.protocol +

+ + + + + + + + + +
+Class Summary
ProtocolUtilsUtilities for converting between strings encoded in the response protocol and + collections of items, as well as validating and unpicking protocol messages.
+  + +

+ + + + + + + + + + + + + +
+Enum Summary
DirectiveDirectives supported by the protocol.
StatusStatuses that can follow the STATUS directory.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/package-tree.html b/doc/uk/org/ury/common/protocol/package-tree.html new file mode 100644 index 0000000..7c545b7 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/package-tree.html @@ -0,0 +1,163 @@ + + + + + + +uk.org.ury.common.protocol Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.common.protocol +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Enum Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/common/protocol/package-use.html b/doc/uk/org/ury/common/protocol/package-use.html new file mode 100644 index 0000000..ef87ddf --- /dev/null +++ b/doc/uk/org/ury/common/protocol/package-use.html @@ -0,0 +1,176 @@ + + + + + + +Uses of Package uk.org.ury.common.protocol + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
uk.org.ury.common.protocol

+
+ + + + + + + + + +
+Packages that use uk.org.ury.common.protocol
uk.org.ury.common.protocol  
+  +

+ + + + + + + + + + + +
+Classes in uk.org.ury.common.protocol used by uk.org.ury.common.protocol
Directive + +
+          Directives supported by the protocol.
Status + +
+          Statuses that can follow the STATUS directory.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + -- cgit v1.2.3