org.jfree.io

Class SerialUtilities

java.lang.Object

org.jfree.io.SerialUtilities

public class SerialUtilities
extends Object

A class containing useful utility methods relating to serialization.

Author:

David Gilbert

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isSerializable(Class c) Returns true if a class implements Serializable and false otherwise.
static AttributedString	readAttributedString(ObjectInputStream stream) Reads a AttributedString object that has been serialised by the writeAttributedString(AttributedString, ObjectOutputStream) method.
static Composite	readComposite(ObjectInputStream stream) Reads a Composite object that has been serialised by the writeComposite(Composite, ObjectOutputStream) method.
static Paint	readPaint(ObjectInputStream stream) Reads a Paint object that has been serialised by the writePaint(Paint, ObjectOutputStream) method.
static Point2D	readPoint2D(ObjectInputStream stream) Reads a Point2D object that has been serialised by the writePoint2D(Point2D, ObjectOutputStream) method.
static Shape	readShape(ObjectInputStream stream) Reads a Shape object that has been serialised by the writeShape(Shape, ObjectOutputStream) method.
static Stroke	readStroke(ObjectInputStream stream) Reads a Stroke object that has been serialised by the writeStroke(Stroke, ObjectOutputStream) method.
static void	writeAttributedString(AttributedString as, ObjectOutputStream stream) Serialises an AttributedString object.
static void	writeComposite(Composite composite, ObjectOutputStream stream) Serialises a Composite object.
static void	writePaint(Paint paint, ObjectOutputStream stream) Serialises a Paint object.
static void	writePoint2D(Point2D p, ObjectOutputStream stream) Serialises a Point2D object.
static void	writeShape(Shape shape, ObjectOutputStream stream) Serialises a Shape object.
static void	writeStroke(Stroke stroke, ObjectOutputStream stream) Serialises a Stroke object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isSerializable

public static boolean isSerializable(Class c)

Returns true if a class implements Serializable and false otherwise.

Parameters:

c - the class.

Returns:

A boolean.

readPaint

public static Paint readPaint(ObjectInputStream stream)
                       throws IOException,
                              ClassNotFoundException

Reads a Paint object that has been serialised by the writePaint(Paint, ObjectOutputStream) method.

Parameters:

stream - the input stream (null not permitted).

Returns:

The paint object (possibly null).

Throws:

IOException - if there is an I/O problem.

ClassNotFoundException - if there is a problem loading a class.

writePaint

public static void writePaint(Paint paint,
              ObjectOutputStream stream)
                       throws IOException

Serialises a Paint object.

Parameters:

paint - the paint object (null permitted).

stream - the output stream (null not permitted).

Throws:

IOException - if there is an I/O error.

readStroke

public static Stroke readStroke(ObjectInputStream stream)
                         throws IOException,
                                ClassNotFoundException

Reads a Stroke object that has been serialised by the writeStroke(Stroke, ObjectOutputStream) method.

Parameters:

stream - the input stream (null not permitted).

Returns:

The stroke object (possibly null).

Throws:

IOException - if there is an I/O problem.

ClassNotFoundException - if there is a problem loading a class.

writeStroke

public static void writeStroke(Stroke stroke,
               ObjectOutputStream stream)
                        throws IOException

Serialises a Stroke object. This code handles the BasicStroke class which is the only Stroke implementation provided by the JDK (and isn't directly Serializable).

Parameters:

stroke - the stroke object (null permitted).

stream - the output stream (null not permitted).

Throws:

IOException - if there is an I/O error.

readComposite

public static Composite readComposite(ObjectInputStream stream)
                               throws IOException,
                                      ClassNotFoundException

Reads a Composite object that has been serialised by the writeComposite(Composite, ObjectOutputStream) method.

Parameters:

stream - the input stream (null not permitted).

Returns:

The composite object (possibly null).

Throws:

IOException - if there is an I/O problem.

ClassNotFoundException - if there is a problem loading a class.

Since:

1.0.17

writeComposite

public static void writeComposite(Composite composite,
                  ObjectOutputStream stream)
                           throws IOException

Serialises a Composite object.

Parameters:

composite - the composite object (null permitted).

stream - the output stream (null not permitted).

Throws:

IOException - if there is an I/O error.

Since:

1.0.17

readShape

public static Shape readShape(ObjectInputStream stream)
                       throws IOException,
                              ClassNotFoundException

Reads a Shape object that has been serialised by the writeShape(Shape, ObjectOutputStream) method.

Parameters:

stream - the input stream (null not permitted).

Returns:

The shape object (possibly null).

Throws:

IOException - if there is an I/O problem.

ClassNotFoundException - if there is a problem loading a class.

writeShape

public static void writeShape(Shape shape,
              ObjectOutputStream stream)
                       throws IOException

Serialises a Shape object.

Parameters:

shape - the shape object (null permitted).

stream - the output stream (null not permitted).

Throws:

IOException - if there is an I/O error.

readPoint2D

public static Point2D readPoint2D(ObjectInputStream stream)
                           throws IOException

Reads a Point2D object that has been serialised by the writePoint2D(Point2D, ObjectOutputStream) method.

Parameters:

stream - the input stream (null not permitted).

Returns:

The point object (possibly null).

Throws:

IOException - if there is an I/O problem.

writePoint2D

public static void writePoint2D(Point2D p,
                ObjectOutputStream stream)
                         throws IOException

Serialises a Point2D object.

Parameters:

p - the point object (null permitted).

stream - the output stream (null not permitted).

Throws:

IOException - if there is an I/O error.

readAttributedString

public static AttributedString readAttributedString(ObjectInputStream stream)
                                             throws IOException,
                                                    ClassNotFoundException

Reads a AttributedString object that has been serialised by the writeAttributedString(AttributedString, ObjectOutputStream) method.

Parameters:

stream - the input stream (null not permitted).

Returns:

The attributed string object (possibly null).

Throws:

IOException - if there is an I/O problem.

ClassNotFoundException - if there is a problem loading a class.

writeAttributedString

public static void writeAttributedString(AttributedString as,
                         ObjectOutputStream stream)
                                  throws IOException

Serialises an AttributedString object.

Parameters:

as - the attributed string object (null permitted).

stream - the output stream (null not permitted).

Throws:

IOException - if there is an I/O error.