OptionalDataException.java 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. /* OptionalDataException.java -- indicates unexpected data in serialized stream
  2. Copyright (C) 1998, 2000, 2001, 2002, 2005 Free Software Foundation, Inc.
  3. This file is part of GNU Classpath.
  4. GNU Classpath is free software; you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation; either version 2, or (at your option)
  7. any later version.
  8. GNU Classpath is distributed in the hope that it will be useful, but
  9. WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. General Public License for more details.
  12. You should have received a copy of the GNU General Public License
  13. along with GNU Classpath; see the file COPYING. If not, write to the
  14. Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  15. 02110-1301 USA.
  16. Linking this library statically or dynamically with other modules is
  17. making a combined work based on this library. Thus, the terms and
  18. conditions of the GNU General Public License cover the whole
  19. combination.
  20. As a special exception, the copyright holders of this library give you
  21. permission to link this library with independent modules to produce an
  22. executable, regardless of the license terms of these independent
  23. modules, and to copy and distribute the resulting executable under
  24. terms of your choice, provided that you also meet, for each linked
  25. independent module, the terms and conditions of the license of that
  26. module. An independent module is a module which is not derived from
  27. or based on this library. If you modify this library, you may extend
  28. this exception to your version of the library, but you are not
  29. obligated to do so. If you do not wish to do so, delete this
  30. exception statement from your version. */
  31. package java.io;
  32. /**
  33. * This exception is thrown when unexpected data appears in the input
  34. * stream from which a serialized object is being read. There are two
  35. * cases:<br><ul>
  36. * <li>The next stream element is primitive data. <code>eof</code> will
  37. * be false, and <code>count</code> is the number of bytes of primitive
  38. * data available.</li>
  39. * <li>The data consumable by readObject or readExternal has been exhausted.
  40. * <code>eof</code> is true, and <code>count</code> is 0.</li>
  41. * </ul>
  42. *
  43. * @author Aaron M. Renn (arenn@urbanophile.com)
  44. * @author Warren Levy (warrenl@cygnus.com)
  45. * @since 1.1
  46. * @status updated to 1.4
  47. */
  48. public class OptionalDataException extends ObjectStreamException
  49. {
  50. /**
  51. * Compatible with JDK 1.1+.
  52. */
  53. private static final long serialVersionUID = -8011121865681257820L;
  54. /**
  55. * Whether or not the end of the stream has been reached.
  56. *
  57. * @serial the end of the buffer was reached
  58. */
  59. public boolean eof;
  60. /**
  61. * The number of valid bytes that can be read.
  62. *
  63. * @serial the bytes of the buffer remaining
  64. */
  65. public int length;
  66. /**
  67. * Create a new OptionalDataException with an eof parameter indicating
  68. * whether or not the end of stream is reached and the number of valid
  69. * bytes that may be read.
  70. *
  71. * @param eof 'true' if end of stream reached, 'false' otherwise
  72. * @param count The number of valid bytes to be read
  73. */
  74. OptionalDataException(boolean eof, int count)
  75. {
  76. this.eof = eof;
  77. this.length = count;
  78. }
  79. } // class OptionalDataException