From edf99237651912c729ae89464ca8cc1305c55957 Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Thu, 24 Mar 2011 14:45:36 +0000 Subject: Documentation refresh; classpath update; CODECHANGE: moved content serving in request handling to abstract request handler. --- doc/uk/org/ury/common/protocol/Directive.html | 4 +- doc/uk/org/ury/common/protocol/ProtocolUtils.html | 31 +-- doc/uk/org/ury/common/protocol/Status.html | 4 +- .../ury/common/protocol/class-use/Directive.html | 4 +- .../common/protocol/class-use/ProtocolUtils.html | 4 +- .../org/ury/common/protocol/class-use/Status.html | 4 +- .../exceptions/DecodeFailureException.html | 20 +- .../exceptions/EncodeFailureException.html | 250 +++++++++++++++++++++ .../exceptions/InvalidMessageException.html | 8 +- .../class-use/DecodeFailureException.html | 10 +- .../class-use/EncodeFailureException.html | 180 +++++++++++++++ .../class-use/InvalidMessageException.html | 8 +- .../common/protocol/exceptions/package-frame.html | 6 +- .../protocol/exceptions/package-summary.html | 8 +- .../common/protocol/exceptions/package-tree.html | 6 +- .../common/protocol/exceptions/package-use.html | 10 +- doc/uk/org/ury/common/protocol/package-frame.html | 4 +- .../org/ury/common/protocol/package-summary.html | 4 +- doc/uk/org/ury/common/protocol/package-tree.html | 4 +- doc/uk/org/ury/common/protocol/package-use.html | 4 +- 20 files changed, 509 insertions(+), 64 deletions(-) create mode 100644 doc/uk/org/ury/common/protocol/exceptions/EncodeFailureException.html create mode 100644 doc/uk/org/ury/common/protocol/exceptions/class-use/EncodeFailureException.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 index 6896a31..7b34397 100644 --- a/doc/uk/org/ury/common/protocol/Directive.html +++ b/doc/uk/org/ury/common/protocol/Directive.html @@ -2,12 +2,12 @@ - + Directive - + 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 @@ - + ProtocolUtils - + @@ -140,11 +140,11 @@ Utilities for converting between strings encoded in the response protocol and -static java.util.Map<?,?> +static java.util.Map<java.lang.String,java.lang.Object> decode(java.lang.String string)
-          Decode a protocol string into a key-value map. +          Decodes a protocol string into a key-value map. @@ -157,10 +157,10 @@ Utilities for converting between strings encoded in the response protocol and static boolean -responseIsOK(java.util.Map<?,?> response) +responseIsOK(java.util.Map<java.lang.String,java.lang.Object> response)
-          Check if a response is flagged as having OK status. +          Checks if a response is flagged as having OK status.   @@ -205,7 +205,8 @@ public ProtocolUtils()

encode

-public static java.lang.String encode(java.util.Map<java.lang.String,java.lang.Object> items)
+public static java.lang.String encode(java.util.Map<java.lang.String,java.lang.Object> items) + throws EncodeFailureException
Encode a key-value map into a protocol string. @@ -217,7 +218,9 @@ public static java.lang.String encode(java.util.Map<java.lang.String,j
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.
+
Returns:
A string containing the encoded representation of the map. +
Throws: +
EncodeFailureException - if the encoding engine fails to encode the map as a string.
@@ -225,16 +228,16 @@ public static java.lang.String encode(java.util.Map<java.lang.String,j

decode

-public static java.util.Map<?,?> decode(java.lang.String string)
-                                 throws DecodeFailureException
+public static java.util.Map<java.lang.String,java.lang.Object> decode(java.lang.String string) + throws DecodeFailureException
-
Decode a protocol string into a key-value map. +
Decodes 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.
+
DecodeFailureException - if the decoding engine fails to decode the string.
@@ -242,10 +245,10 @@ public static java.util.Map<?,?> decode(java.lang.String strin

responseIsOK

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

Parameters:
response - The response message, as a key-value map (eg in decoded diff --git a/doc/uk/org/ury/common/protocol/Status.html b/doc/uk/org/ury/common/protocol/Status.html index 2aacd37..5817226 100644 --- a/doc/uk/org/ury/common/protocol/Status.html +++ b/doc/uk/org/ury/common/protocol/Status.html @@ -2,12 +2,12 @@ - + Status - + diff --git a/doc/uk/org/ury/common/protocol/class-use/Directive.html b/doc/uk/org/ury/common/protocol/class-use/Directive.html index 8e8773a..3fbcaf0 100644 --- a/doc/uk/org/ury/common/protocol/class-use/Directive.html +++ b/doc/uk/org/ury/common/protocol/class-use/Directive.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.common.protocol.Directive - + diff --git a/doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html b/doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html index 3fa2218..4b1c665 100644 --- a/doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html +++ b/doc/uk/org/ury/common/protocol/class-use/ProtocolUtils.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.common.protocol.ProtocolUtils - + diff --git a/doc/uk/org/ury/common/protocol/class-use/Status.html b/doc/uk/org/ury/common/protocol/class-use/Status.html index be9a264..916c5ce 100644 --- a/doc/uk/org/ury/common/protocol/class-use/Status.html +++ b/doc/uk/org/ury/common/protocol/class-use/Status.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.common.protocol.Status - + diff --git a/doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html b/doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html index 50bc91a..c5b30dd 100644 --- a/doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html +++ b/doc/uk/org/ury/common/protocol/exceptions/DecodeFailureException.html @@ -2,12 +2,12 @@ - + DecodeFailureException - + @@ -56,7 +56,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -127,10 +127,10 @@ Exception thrown when the protocol decoder fails. Constructor Summary -DecodeFailureException(java.lang.String reason) +DecodeFailureException(java.lang.Throwable cause)
-          Construct a new DecodeFailureException with a reason. +          Construct a new DecodeFailureException with a chained exception.   @@ -174,15 +174,15 @@ Exception thrown when the protocol decoder fails. -

+

DecodeFailureException

-public DecodeFailureException(java.lang.String reason)
+public DecodeFailureException(java.lang.Throwable cause)
-
Construct a new DecodeFailureException with a reason. +
Construct a new DecodeFailureException with a chained exception.

-
Parameters:
reason - The reason for throwing the exception.
+
Parameters:
cause - The exception to chain.
@@ -216,7 +216,7 @@ public DecodeFailureException(java.lang.String reason)  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/common/protocol/exceptions/EncodeFailureException.html b/doc/uk/org/ury/common/protocol/exceptions/EncodeFailureException.html new file mode 100644 index 0000000..2d932d7 --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/EncodeFailureException.html @@ -0,0 +1,250 @@ + + + + + + +EncodeFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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 EncodeFailureException

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

+Exception thrown when the protocol encoder fails. +

+ +

+

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

+ + + + + + + + + + + +
+Constructor Summary
EncodeFailureException(java.lang.Throwable cause) + +
+          Construct a new EncodeFailureException with a chained exception.
+  + + + + + + + +
+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
+ +

+EncodeFailureException

+
+public EncodeFailureException(java.lang.Throwable cause)
+
+
Construct a new EncodeFailureException with a chained exception. +

+

+
Parameters:
cause - The exception to chain.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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 index 0653219..b515d43 100644 --- a/doc/uk/org/ury/common/protocol/exceptions/InvalidMessageException.html +++ b/doc/uk/org/ury/common/protocol/exceptions/InvalidMessageException.html @@ -2,12 +2,12 @@ - + InvalidMessageException - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -216,7 +216,7 @@ public InvalidMessageException(java.lang.String reason) - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   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 index e6b89a8..52896c4 100644 --- a/doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html +++ b/doc/uk/org/ury/common/protocol/exceptions/class-use/DecodeFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.common.protocol.exceptions.DecodeFailureException - + @@ -116,11 +116,11 @@ Uses of -static java.util.Map<?,?> +static java.util.Map<java.lang.String,java.lang.Object> ProtocolUtils.decode(java.lang.String string)
-          Decode a protocol string into a key-value map. +          Decodes a protocol string into a key-value map.   @@ -141,7 +141,7 @@ Uses of - java.util.Map<?,?> + java.util.Map<java.lang.String,java.lang.Object> Client.get(java.lang.String file)
diff --git a/doc/uk/org/ury/common/protocol/exceptions/class-use/EncodeFailureException.html b/doc/uk/org/ury/common/protocol/exceptions/class-use/EncodeFailureException.html new file mode 100644 index 0000000..6f571ae --- /dev/null +++ b/doc/uk/org/ury/common/protocol/exceptions/class-use/EncodeFailureException.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Class uk.org.ury.common.protocol.exceptions.EncodeFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

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

+ + + + + + + + + +
Methods in uk.org.ury.common.protocol that throw EncodeFailureException
+static java.lang.StringProtocolUtils.encode(java.util.Map<java.lang.String,java.lang.Object> items) + +
+          Encode a key-value map into a protocol string.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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 index 38cd47a..81710b1 100644 --- a/doc/uk/org/ury/common/protocol/exceptions/class-use/InvalidMessageException.html +++ b/doc/uk/org/ury/common/protocol/exceptions/class-use/InvalidMessageException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.common.protocol.exceptions.InvalidMessageException - + @@ -117,10 +117,10 @@ Uses of static boolean -ProtocolUtils.responseIsOK(java.util.Map<?,?> response) +ProtocolUtils.responseIsOK(java.util.Map<java.lang.String,java.lang.Object> response)
-          Check if a response is flagged as having OK status. +          Checks if a response is flagged as having OK status.   diff --git a/doc/uk/org/ury/common/protocol/exceptions/package-frame.html b/doc/uk/org/ury/common/protocol/exceptions/package-frame.html index dc92d8b..0bbc295 100644 --- a/doc/uk/org/ury/common/protocol/exceptions/package-frame.html +++ b/doc/uk/org/ury/common/protocol/exceptions/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.common.protocol.exceptions - + @@ -25,6 +25,8 @@ Exceptions 
DecodeFailureException
+EncodeFailureException +
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 index 5c26eba..acb4b40 100644 --- a/doc/uk/org/ury/common/protocol/exceptions/package-summary.html +++ b/doc/uk/org/ury/common/protocol/exceptions/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.common.protocol.exceptions - + @@ -93,6 +93,10 @@ Package uk.org.ury.common.protocol.exceptions Exception thrown when the protocol decoder fails. +EncodeFailureException +Exception thrown when the protocol encoder fails. + + InvalidMessageException Generic exception thrown when a protocol function cannot process a message due to an issue with the message. diff --git a/doc/uk/org/ury/common/protocol/exceptions/package-tree.html b/doc/uk/org/ury/common/protocol/exceptions/package-tree.html index 83fdb25..8d22f87 100644 --- a/doc/uk/org/ury/common/protocol/exceptions/package-tree.html +++ b/doc/uk/org/ury/common/protocol/exceptions/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.common.protocol.exceptions Class Hierarchy - + @@ -95,7 +95,7 @@ Class Hierarchy
  • java.lang.Throwable (implements java.io.Serializable) diff --git a/doc/uk/org/ury/common/protocol/exceptions/package-use.html b/doc/uk/org/ury/common/protocol/exceptions/package-use.html index 3737f62..3075a67 100644 --- a/doc/uk/org/ury/common/protocol/exceptions/package-use.html +++ b/doc/uk/org/ury/common/protocol/exceptions/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.common.protocol.exceptions - + @@ -117,6 +117,12 @@ Classes in +EncodeFailureException + +
    +          Exception thrown when the protocol encoder fails. + + InvalidMessageException
    diff --git a/doc/uk/org/ury/common/protocol/package-frame.html b/doc/uk/org/ury/common/protocol/package-frame.html index 3b56421..08bdd9b 100644 --- a/doc/uk/org/ury/common/protocol/package-frame.html +++ b/doc/uk/org/ury/common/protocol/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.common.protocol - + diff --git a/doc/uk/org/ury/common/protocol/package-summary.html b/doc/uk/org/ury/common/protocol/package-summary.html index e6850e6..7ee0ec2 100644 --- a/doc/uk/org/ury/common/protocol/package-summary.html +++ b/doc/uk/org/ury/common/protocol/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.common.protocol - + diff --git a/doc/uk/org/ury/common/protocol/package-tree.html b/doc/uk/org/ury/common/protocol/package-tree.html index 7de4a9c..29d77dd 100644 --- a/doc/uk/org/ury/common/protocol/package-tree.html +++ b/doc/uk/org/ury/common/protocol/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.common.protocol Class Hierarchy - + diff --git a/doc/uk/org/ury/common/protocol/package-use.html b/doc/uk/org/ury/common/protocol/package-use.html index cbec9e8..5b44a36 100644 --- a/doc/uk/org/ury/common/protocol/package-use.html +++ b/doc/uk/org/ury/common/protocol/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.common.protocol - + -- cgit v1.2.3