libjava/classpath/java/io/ObjectInputValidation.java

   1 /* ObjectInputValidation.java -- Validate an object
   2    Copyright (C) 1998, 2003 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.io;
  40
  41 /**
  42   * This class allows an object to validate that it is valid after
  43   * deserialization has run completely for it and all dependent objects.
  44   * This allows an object to determine if it is invalid even if all
  45   * state data was correctly deserialized from the stream.  It can also
  46   * be used to perform re-initialization type activities on an object
  47   * after it has been completely deserialized.
  48   *
  49   * Since this method functions as a type of callback, it must be
  50   * registered through <code>ObjectInputStream.registerValidation</code>
  51   * in order to be invoked.  This is typically done in the
  52   * <code>readObject</code> method.
  53   *
  54   * @author Aaron M. Renn (arenn@urbanophile.com)
  55   *
  56   * @see ObjectInputStream#registerValidation
  57   */
  58 public interface ObjectInputValidation
  59 {
  60   /**
  61     * This method is called to validate an object after serialization
  62     * is complete.  If the object is invalid an exception is thrown.
  63     *
  64     * @exception InvalidObjectException If the object is invalid
  65     */
  66   void validateObject() throws InvalidObjectException;
  67 }