Constructor Detail

• NbObjectInputStream

  public NbObjectInputStream​(java.io.InputStream is)
                      throws java.io.IOException

  Create a new object input.

  Parameters:

  is - underlying input stream

  Throws:

  java.io.IOException - for the usual reasons

Method Detail

• resolveClass

  protected java.lang.Class resolveClass​(java.io.ObjectStreamClass v)
                                  throws java.io.IOException,
                                         java.lang.ClassNotFoundException

  Overrides:

  resolveClass in class java.io.ObjectInputStream

  Throws:

  java.io.IOException

  java.lang.ClassNotFoundException

• readClassDescriptor

  protected java.io.ObjectStreamClass readClassDescriptor​()
                                                   throws java.io.IOException,
                                                          java.lang.ClassNotFoundException

  Provides a special handling for renaming of serialized classes.

  Often, as the time goes the serialized classes evolve. They can be moved to new packages, renamed or changed (by a mistake) to not reflect the version of class stored in previous sessions.

  This method deals with some of this incompatibilites and provides the module owners a way how to fix some of them.

  When a class is read, the Utilities.translate is consulted to find out what whether the name of the class is listed there and what new value is assigned to it. This allows complete rename of the serialized class. For example: org.netbeans.core.NbMainExplorer can be renamed to org.netbeans.core.ui.NbExp - of course supposing that the new class is able to read the serialized fields of the old one.

  Another useful feature of this method is the ability to supress wrong serialVersionUID. This was causing us a lot of problems, because people were forgetting to specify the serialVersionUID field in their sources and then it was hard to recover from it. Right now we have a solution: Just use Utilities.translate framework to assing your class org.yourpackage.YourClass the same name as it had e.g. org.yourpackage.YourClass. This will be interpreted by this method as a hit to suppress serialVersionUID and the NbObjectInputStream will ignore its value.

  Please see Utilities.translate to learn how your module can provide list of classes that changed name or want to suppress serialVersionUID.

  Overrides:

  readClassDescriptor in class java.io.ObjectInputStream

  Throws:

  java.io.IOException

  java.lang.ClassNotFoundException

• readSafely

  public static java.lang.Object readSafely​(java.io.ObjectInput oi)
                                     throws java.io.IOException

  Reads an object from the given object input. The object had to be saved by the NbObjectOutputStream.writeSafely(java.io.ObjectOutput, java.lang.Object) method.

  Parameters:

  oi - object input

  Returns:

  the read object

  Throws:

  java.io.IOException - if IO error occured

  SafeException - if the operation failed but the stream is ok for further reading

• skipSafely

  public static void skipSafely​(java.io.ObjectInput oi)
                         throws java.io.IOException

  Skips an object from the given object input without loading it. The object had to be saved by the NbObjectOutputStream.writeSafely(java.io.ObjectOutput, java.lang.Object) method.

  Parameters:

  oi - object input

  Throws:

  java.io.IOException - if an I/O error occurred