summaryrefslogtreecommitdiff
path: root/java/src/Ice/UserExceptionWriter.java
diff options
context:
space:
mode:
authorMark Spruiell <mes@zeroc.com>2010-05-21 20:14:31 -0700
committerMark Spruiell <mes@zeroc.com>2010-05-21 20:14:31 -0700
commit635675554183157d852c79054c03cb78f8411dfa (patch)
treeda5e560d283155d3af8d32a7882da58b4b573531 /java/src/Ice/UserExceptionWriter.java
parentbug 4733 - fixing bugs in AMD exceptions (diff)
downloadice-635675554183157d852c79054c03cb78f8411dfa.tar.bz2
ice-635675554183157d852c79054c03cb78f8411dfa.tar.xz
ice-635675554183157d852c79054c03cb78f8411dfa.zip
bug 4623 - missing doc comments
Diffstat (limited to 'java/src/Ice/UserExceptionWriter.java')
-rw-r--r--java/src/Ice/UserExceptionWriter.java20
1 files changed, 20 insertions, 0 deletions
diff --git a/java/src/Ice/UserExceptionWriter.java b/java/src/Ice/UserExceptionWriter.java
index 71bc31b6727..67cf201d5ec 100644
--- a/java/src/Ice/UserExceptionWriter.java
+++ b/java/src/Ice/UserExceptionWriter.java
@@ -9,16 +9,36 @@
package Ice;
+/**
+ * Allows a Dynamic Ice application to wrap a native exception and
+ * intercept its marshaling.
+ *
+ * @see OutputStream
+ **/
public abstract class UserExceptionWriter extends UserException
{
+ /**
+ * Creates a writer for the given communicator.
+ **/
public UserExceptionWriter(Communicator communicator)
{
_communicator = communicator;
}
+ /**
+ * Marshal the encapsulated exception into an output stream.
+ *
+ * @param os The output stream.
+ **/
public abstract void
write(Ice.OutputStream os);
+ /**
+ * Indicates whether the encapsulated exception contains one or more
+ * data members that are instances of Slice classes.
+ *
+ * @return True if the exception contains classes, or false otherwise.
+ **/
public abstract boolean
usesClasses();