Removing the serialVersionUID warning in Eclipse

Looks familiar?

The serializable class RTFDocument does not declare a static final serialVersionUID field warning

By default Eclipse warns you about not declaring a serialVersionUID for any serializable class you write. But what is the serialVersionUID and what’s the use of it?

http://www.javapractices.com/Topic45.cjp:

The serialVersionUID is a universal version identifier for a Serializable class. Deserialization uses this number to ensure that a loaded class corresponds exactly to a serialized object.

http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html:

The serialization runtime associates with each serializable class a version number, called a serialVersionUID, which is used during deserialization to verify that the sender and receiver of a serialized object have loaded classes for that object that are compatible with respect to serialization.

If the receiver has loaded a class for the object that has a different serialVersionUID than that of the corresponding sender’s class, then deserialization will result in an InvalidClassException.

A serializable class can declare its own serialVersionUID explicitly by declaring a field named “serialVersionUID” that must be static, final, and of type long:

ANY-ACCESS-MODIFIER static final long serialVersionUID = 42L;

If a serializable class does not explicitly declare a serialVersionUID, then the serialization runtime will calculate a default serialVersionUID value for that class based on various aspects of the class, as described in the Java(TM) Object Serialization Specification.

However, it is strongly recommended that all serializable classes explicitly declare serialVersionUID values, since the default serialVersionUID computation is highly sensitive to class details that may vary depending on compiler implementations, and can thus result in unexpected InvalidClassExceptions during deserialization.

Therefore, to guarantee a consistent serialVersionUID value across different java compiler implementations, a serializable class must declare an explicit serialVersionUID value. It is also strongly advised that explicit serialVersionUID declarations use the private modifier where possible, since such declarations apply only to the immediately declaring class — serialVersionUID fields are not useful as inherited members.

But how do you remove the Eclipse warning regarding the serialVersionUID not being declared for your serializable class?

Go to “Window” > “Preferences”. Type in the upper left search box “errors”. This should filter the options displayed. Browse the tree to “Java” > “Compiler” > “Errors Warnings”. Choose the “Potential programming problems” block and set the first option to “Ignore”. Hit the “Apply” button with sufficient thrust to cause it to succumb to you, the Eclipse master of them all n00bs.

Voila. You want a picture with that?

ignore_serialversionuid_warning.PNG

Share and Enjoy:These icons link to social bookmarking sites where readers can share and discover new web pages.
  • blinkbits
  • BlinkList
  • del.icio.us
  • digg
  • Fark
  • Furl
  • Reddit
  • Spurl
  • YahooMyWeb

4 comments so far

  1. ojs May 17, 2007 1:26 am

    thank you!!!

  2. Danny March 1, 2008 3:58 pm

    Thanks, this helped me so much. I was already going crazy about my whole project being a sole warning….

  3. Sonali Rawool April 11, 2008 12:05 pm

    Thanks for the details on serialization and deserialization….it was very useful….

  4. Srujan August 25, 2008 5:52 pm

    This was very informative, thank you.

Leave a comment

Please be polite and on topic. Your e-mail will never be published.