jhplot.io

Class Serialized

java.lang.Object

jhplot.io.Serialized

public class Serialized
extends java.lang.Object

Methods used for serialization. Includes write (read) for the standard serialization. Objects can be compressed on-fly using GZip. Also, one can use XML format for serialization (writeXML(), readXML()). XML serialization is based on XSream and not compressed. Files can be read from URL.

Constructor Summary

Constructors

Constructor and Description
Serialized()

Method Summary

Modifier and Type	Method and Description
void	doc() Show online documentation.
static java.lang.Object	fromXML(java.lang.String xml) Get object to XML using XSream package
static java.lang.Object	read(java.io.File file, boolean compressed) Read an object from a serialized file
static java.lang.Object	read(java.lang.String name) Read an object from a serialized file.
static java.lang.Object	read(java.net.URL url, boolean compressed) Read an object from an URL
static java.lang.Object	readXML(java.lang.String name) Read an object from a serialized XML file (should be written using writeXML() method).
static java.lang.String	toXML(java.lang.Object ob) Convert object to XML using XSream package
static int	write(java.lang.Object o, java.lang.String name) Write an object to a serialized file.
static int	write(java.lang.Object o, java.lang.String name, boolean compressed) Write an object to a serialized file.
static int	writeXML(java.lang.Object o, java.lang.String name) Write an object to a serialized XML file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Serialized

public Serialized()

Method Detail

write

public static int write(java.lang.Object o,
                        java.lang.String name,
                        boolean compressed)

Write an object to a serialized file. Use the method read() to read it back.

Parameters:

o - object to serialize into a file

name - serialized file name for output.

compression - set true if file should be compressed.

Returns:

zero if no errors

write

public static int write(java.lang.Object o,
                        java.lang.String name)

Write an object to a serialized file. Use the method read() to read it back. File will be compressed.

Parameters:

o - object to serialize into a file

name - serialized file name for output.

Returns:

zero if no errors

writeXML

public static int writeXML(java.lang.Object o,
                           java.lang.String name)

Write an object to a serialized XML file. Use the method readXML() to get it back.

Parameters:

o - object to serialize into a file

name - serialized file name for the output.

Returns:

zero if no errors

read

public static java.lang.Object read(java.io.File file,
                                    boolean compressed)

Read an object from a serialized file

Parameters:

file - serialized file for input.

compressed - set true if file is compressed.

Returns:

object

read

public static java.lang.Object read(java.net.URL url,
                                    boolean compressed)

Read an object from an URL

Parameters:

name - serialized file name for input from URL

compressed - set true if file is compressed.

Returns:

object

read

public static java.lang.Object read(java.lang.String name)

Read an object from a serialized file. File is assumed to be compressed, i.e when it was saved using write(obj,name) method.

Parameters:

name - serialized file name for input.

Returns:

object

readXML

public static java.lang.Object readXML(java.lang.String name)

Read an object from a serialized XML file (should be written using writeXML() method).

Parameters:

name - serialized XML file name for the input.

Returns:

object

toXML

public static java.lang.String toXML(java.lang.Object ob)

Convert object to XML using XSream package

Parameters:

ob -

Returns:

XML string

fromXML

public static java.lang.Object fromXML(java.lang.String xml)

Get object to XML using XSream package

Parameters:

xml - XML string

Returns:

object

doc

public void doc()

Show online documentation.