summaryrefslogtreecommitdiff
path: root/java/io/ObjectInputValidation.java
diff options
context:
space:
mode:
authorAaron M. Renn <arenn@urbanophile.com>2003-04-06 20:43:57 +0000
committerAaron M. Renn <arenn@urbanophile.com>2003-04-06 20:43:57 +0000
commit3f5337cf497e56539144c7f9610e5ab245da648f (patch)
tree502f583a836dc4ff7e8f4ffdff0a39adcb238386 /java/io/ObjectInputValidation.java
parente82a5d06e78252508066821f72abc49a6bf4b4fc (diff)
downloadclasspath-3f5337cf497e56539144c7f9610e5ab245da648f.tar.gz
* java/io/ObjectStreamException
* java/io/FileFilter * java/io/FilenameFilter * java/io/ObjectInput * java/io/ObjectOutput * java/io/ObjectStreamConstants Minor doc fixes, format fixes, spelling corrections, etc. * java/io/DataInput Corrected code samples in Javadocs to match reality * java/io/DataOutput * java/io/ObjectInputValidation Major documentation fixes - all Javadocs re-written or updated
Diffstat (limited to 'java/io/ObjectInputValidation.java')
-rw-r--r--java/io/ObjectInputValidation.java19
1 files changed, 15 insertions, 4 deletions
diff --git a/java/io/ObjectInputValidation.java b/java/io/ObjectInputValidation.java
index 2259eb832..af9da5fa3 100644
--- a/java/io/ObjectInputValidation.java
+++ b/java/io/ObjectInputValidation.java
@@ -39,16 +39,27 @@ exception statement from your version. */
package java.io;
/**
- * What does this interface really do?
+ * This class allows an object to validate that it is valid after
+ * deserialization has run completely for it and all dependent objects.
+ * This allows an object to determine if it is invalid even if all
+ * state data was correctly deserialized from the stream. It can also
+ * be used to perform re-initialization type activities on an object
+ * after it has been completely deserialized.
+ *
+ * Since this method functions as a type of callback, it must be
+ * registered through <code>ObjectInputStream.registerValidation</code>
+ * in order to be invoked. This is typically done in the
+ * <code>readObject</code> method.
*
* @author Aaron M. Renn (arenn@urbanophile.com)
+ *
+ * @see ObjectInputStream#registerValidation
*/
public interface ObjectInputValidation
{
-
/**
- * This method is called to validate an object. If the object is invalid
- * an exception is thrown.
+ * This method is called to validate an object after serialization
+ * is complete. If the object is invalid an exception is thrown.
*
* @exception InvalidObjectException If the object is invalid
*/