OptionalDataException (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.lang.Throwable
  • • java.lang.Exception
      • • java.io.IOException
          * * java.io.ObjectStreamException
          * * java.io.OptionalDataException

• All Implemented Interfaces:
  Serializable

public class OptionalDataException
extends ObjectStreamException
Exception indicating the failure of an object read operation due to unread primitive data, or the end of data belonging to a serialized object in the stream. This exception may be thrown in two cases:

• An attempt was made to read an object when the next element in the stream is primitive data. In this case, the OptionalDataException's length field is set to the number of bytes of primitive data immediately readable from the stream, and the eof field is set to false.

• An attempt was made to read past the end of data consumable by a class-defined readObject or readExternal method. In this case, the OptionalDataException's eof field is set to true, and the length field is set to 0.
  Since:
  JDK1.1
  See Also:
  Serialized Form

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  boolean	eof	True if there is no more data in the buffered part of the stream.
  int	length	The number of bytes of primitive data available to be read in the current buffer.

  • Method Summary

    * ### Methods inherited from class java.lang.[Throwable](../../java/lang/Throwable.html "class in java.lang")  
    `[addSuppressed](../../java/lang/Throwable.html#addSuppressed-java.lang.Throwable-), [fillInStackTrace](../../java/lang/Throwable.html#fillInStackTrace--), [getCause](../../java/lang/Throwable.html#getCause--), [getLocalizedMessage](../../java/lang/Throwable.html#getLocalizedMessage--), [getMessage](../../java/lang/Throwable.html#getMessage--), [getStackTrace](../../java/lang/Throwable.html#getStackTrace--), [getSuppressed](../../java/lang/Throwable.html#getSuppressed--), [initCause](../../java/lang/Throwable.html#initCause-java.lang.Throwable-), [printStackTrace](../../java/lang/Throwable.html#printStackTrace--), [printStackTrace](../../java/lang/Throwable.html#printStackTrace-java.io.PrintStream-), [printStackTrace](../../java/lang/Throwable.html#printStackTrace-java.io.PrintWriter-), [setStackTrace](../../java/lang/Throwable.html#setStackTrace-java.lang.StackTraceElement:A-), [toString](../../java/lang/Throwable.html#toString--)`  
    * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
    `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Field Detail

     * #### length  
     public int length  
     The number of bytes of primitive data available to be read in the current buffer.  
     * #### eof  
     public boolean eof  
     True if there is no more data in the buffered part of the stream.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.