info.pppc.base.io

Class ObjectStreamTranslator

java.lang.Object

info.pppc.base.io.ObjectStreamTranslator

public class ObjectStreamTranslator
extends java.lang.Object

The object stream translator enables a more efficient serialization by assigning abbreviations to class names. It is used by the default object input and output stream of BASE. Users can register abbreviations for their serializable classes. Note that this mechanism should mainly be used by system classes that are available on all systems since adding an abbreviations might make debugging harder and there is no mechanism that guarantees that the assigned abbreviations are unique. Note that users should not use '/' as the first character for their abbreviations since this is used to abbreviate classes from the java language. Similarly, applications should not use ';' as first character since this is used by BASE and PCOM system services and data types. Typically, BASE data types will be abbreviated with ';B', PCOM data types will be abbreviated with ';P'.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABBREVIATION_ARRAY_BOOLEAN The abbreviation for a one-dimensional array of type Boolean.
static java.lang.String	ABBREVIATION_ARRAY_BYTE The abbreviation for a one-dimensional array of type Byte.
static java.lang.String	ABBREVIATION_ARRAY_CHARACTER The abbreviation for a one-dimensional array of type Character.
static java.lang.String	ABBREVIATION_ARRAY_INTEGER The abbreviation for a one-dimensional array of type Integer.
static java.lang.String	ABBREVIATION_ARRAY_LONG The abbreviation for a one-dimensional array of type Long.
static java.lang.String	ABBREVIATION_ARRAY_OBJECT The abbreviation for a one-dimensional array of type Object.
static java.lang.String	ABBREVIATION_ARRAY_SHORT The abbreviation for a one-dimensional array of type Short.
static java.lang.String	ABBREVIATION_ARRAY_STRING The abbreviation for a one-dimensional array of type String.
static java.lang.String	ABBREVIATION_BOOLEAN The abbreviation for classes of type Boolean.
static java.lang.String	ABBREVIATION_BYTE The abbreviation for classes of type Byte.
static java.lang.String	ABBREVIATION_CHARACTER The abbreviation for classes of type Character.
static java.lang.String	ABBREVIATION_HASHTABLE The abbreviation for a one-dimensional array of type Hashtable.
static java.lang.String	ABBREVIATION_INTEGER The abbreviation for classes of type Integer.
static java.lang.String	ABBREVIATION_LONG The abbreviation for classes of type Long.
static java.lang.String	ABBREVIATION_NULL The abbreviation for objects with the value null.
static java.lang.String	ABBREVIATION_OBJECT The abbreviation for classes of type Object.
static java.lang.String	ABBREVIATION_PRIMITIVE_BOOLEAN The abbreviation for a one-dimensional array of type boolean.
static java.lang.String	ABBREVIATION_PRIMITIVE_BYTE The abbreviation for a one-dimensional array of type byte.
static java.lang.String	ABBREVIATION_PRIMITIVE_CHAR The abbreviation for a one-dimensional array of type char.
static java.lang.String	ABBREVIATION_PRIMITIVE_INT The abbreviation for a one-dimensional array of type int.
static java.lang.String	ABBREVIATION_PRIMITIVE_LONG The abbreviation for a one-dimensional array of type long.
static java.lang.String	ABBREVIATION_PRIMITIVE_SHORT The abbreviation for a one-dimensional array of type short.
static java.lang.String	ABBREVIATION_REFERENCE The abbreviation for cyclic references within an object graph.
static java.lang.String	ABBREVIATION_SHORT The abbreviation for classes of type Short.
static java.lang.String	ABBREVIATION_STACK The abbreviation for a one-dimensional array of type Stack.
static java.lang.String	ABBREVIATION_STRING The abbreviation for classes of type String.
static java.lang.String	ABBREVIATION_VECTOR The abbreviation for a one-dimensional array of type Vector.

Constructor Summary

Constructors

Constructor and Description
ObjectStreamTranslator()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	containsAbbreviation(java.lang.String abbreviation) Determines whether the specified abbreviation has been registered already.
static boolean	containsClassname(java.lang.String classname) Determines whether the specified class name has been registered already.
static java.lang.String	getAbbreviation(java.lang.String classname) Returns the abbreviation for the specified class name.
static java.lang.String	getClassname(java.lang.String abbreviation) Returns the class name for the specified abbreviation.
static void	register(java.lang.String classname, java.lang.String abbreviation) Registers a certain abbreviation for the specified class name.

Methods inherited from class java.lang.Object

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

Field Detail

ABBREVIATION_REFERENCE

public static final java.lang.String ABBREVIATION_REFERENCE

The abbreviation for cyclic references within an object graph.

See Also:

Constant Field Values

ABBREVIATION_NULL

public static final java.lang.String ABBREVIATION_NULL

The abbreviation for objects with the value null.

See Also:

Constant Field Values

ABBREVIATION_OBJECT

public static final java.lang.String ABBREVIATION_OBJECT

The abbreviation for classes of type Object.

See Also:

Constant Field Values

ABBREVIATION_INTEGER

public static final java.lang.String ABBREVIATION_INTEGER

The abbreviation for classes of type Integer.

See Also:

Constant Field Values

ABBREVIATION_SHORT

public static final java.lang.String ABBREVIATION_SHORT

The abbreviation for classes of type Short.

See Also:

Constant Field Values

ABBREVIATION_LONG

public static final java.lang.String ABBREVIATION_LONG

The abbreviation for classes of type Long.

See Also:

Constant Field Values

ABBREVIATION_BOOLEAN

public static final java.lang.String ABBREVIATION_BOOLEAN

The abbreviation for classes of type Boolean.

See Also:

Constant Field Values

ABBREVIATION_BYTE

public static final java.lang.String ABBREVIATION_BYTE

The abbreviation for classes of type Byte.

See Also:

Constant Field Values

ABBREVIATION_CHARACTER

public static final java.lang.String ABBREVIATION_CHARACTER

The abbreviation for classes of type Character.

See Also:

Constant Field Values

ABBREVIATION_STRING

public static final java.lang.String ABBREVIATION_STRING

The abbreviation for classes of type String.

See Also:

Constant Field Values

ABBREVIATION_PRIMITIVE_INT

public static final java.lang.String ABBREVIATION_PRIMITIVE_INT

The abbreviation for a one-dimensional array of type int.

See Also:

Constant Field Values

ABBREVIATION_PRIMITIVE_LONG

public static final java.lang.String ABBREVIATION_PRIMITIVE_LONG

The abbreviation for a one-dimensional array of type long.

See Also:

Constant Field Values

ABBREVIATION_PRIMITIVE_SHORT

public static final java.lang.String ABBREVIATION_PRIMITIVE_SHORT

The abbreviation for a one-dimensional array of type short.

See Also:

Constant Field Values

ABBREVIATION_PRIMITIVE_BOOLEAN

public static final java.lang.String ABBREVIATION_PRIMITIVE_BOOLEAN

The abbreviation for a one-dimensional array of type boolean.

See Also:

Constant Field Values

ABBREVIATION_PRIMITIVE_BYTE

public static final java.lang.String ABBREVIATION_PRIMITIVE_BYTE

The abbreviation for a one-dimensional array of type byte.

See Also:

Constant Field Values

ABBREVIATION_PRIMITIVE_CHAR

public static final java.lang.String ABBREVIATION_PRIMITIVE_CHAR

The abbreviation for a one-dimensional array of type char.

See Also:

Constant Field Values

ABBREVIATION_ARRAY_OBJECT

public static final java.lang.String ABBREVIATION_ARRAY_OBJECT

The abbreviation for a one-dimensional array of type Object.

See Also:

Constant Field Values

ABBREVIATION_ARRAY_INTEGER

public static final java.lang.String ABBREVIATION_ARRAY_INTEGER

The abbreviation for a one-dimensional array of type Integer.

See Also:

Constant Field Values

ABBREVIATION_ARRAY_SHORT

public static final java.lang.String ABBREVIATION_ARRAY_SHORT

The abbreviation for a one-dimensional array of type Short.

See Also:

Constant Field Values

ABBREVIATION_ARRAY_LONG

public static final java.lang.String ABBREVIATION_ARRAY_LONG

The abbreviation for a one-dimensional array of type Long.

See Also:

Constant Field Values

ABBREVIATION_ARRAY_BOOLEAN

public static final java.lang.String ABBREVIATION_ARRAY_BOOLEAN

The abbreviation for a one-dimensional array of type Boolean.

See Also:

Constant Field Values

ABBREVIATION_ARRAY_BYTE

public static final java.lang.String ABBREVIATION_ARRAY_BYTE

The abbreviation for a one-dimensional array of type Byte.

See Also:

Constant Field Values

ABBREVIATION_ARRAY_CHARACTER

public static final java.lang.String ABBREVIATION_ARRAY_CHARACTER

The abbreviation for a one-dimensional array of type Character.

See Also:

Constant Field Values

ABBREVIATION_ARRAY_STRING

public static final java.lang.String ABBREVIATION_ARRAY_STRING

The abbreviation for a one-dimensional array of type String.

See Also:

Constant Field Values

ABBREVIATION_VECTOR

public static final java.lang.String ABBREVIATION_VECTOR

The abbreviation for a one-dimensional array of type Vector.

See Also:

Constant Field Values

ABBREVIATION_STACK

public static final java.lang.String ABBREVIATION_STACK

The abbreviation for a one-dimensional array of type Stack.

See Also:

Constant Field Values

ABBREVIATION_HASHTABLE

public static final java.lang.String ABBREVIATION_HASHTABLE

The abbreviation for a one-dimensional array of type Hashtable.

See Also:

Constant Field Values

Constructor Detail

ObjectStreamTranslator

public ObjectStreamTranslator()

Method Detail

register

public static void register(java.lang.String classname,
            java.lang.String abbreviation)

Registers a certain abbreviation for the specified class name. Note that neither class names nor abbreviations are allowed to be an empty string. If the class name has been already registered, if the abbreviation has been used already, or if the they do not conform the the conventions described above, this method will throw an exception. Note that neither the class name nor the abbreviation must be null, otherwise an exception will be thrown.

Parameters:

classname - The class name that should be registered.

abbreviation - The abbreviation that should be registered.

Throws:

java.lang.IllegalArgumentException - Thrown if the class name or the abbreviation has been registered already or if one of them represents the empty string.

getClassname

public static java.lang.String getClassname(java.lang.String abbreviation)

Returns the class name for the specified abbreviation. If the abbreviation has not been registered, this method will return the abbreviation that has been passed to the method. Note that the abbreviation must not be null, otherwise an exception will be thrown.

Parameters:

abbreviation - The abbreviation that should be translated into a class name.

Returns:

The class name for the abbreviation or the abbreviation itself, if the abbreviation has not been registered.

Throws:

java.lang.NullPointerException - Thrown if the abbreviation is null.

getAbbreviation

public static java.lang.String getAbbreviation(java.lang.String classname)

Returns the abbreviation for the specified class name. If the class name has not been registered already, this method will return the class name. Note that the class name must not be null, otherwise an exception will be thrown.

Parameters:

classname - The class name whose abbreviation needs to be retrieved.

Returns:

The abbreviation for the class name or the class name itself, if the class name has not been registered.

Throws:

java.lang.NullPointerException - Thrown if the class name is null.

containsClassname

public static boolean containsClassname(java.lang.String classname)

Determines whether the specified class name has been registered already. Returns true if the class name has an abbreviation, false otherwise. Note that this method will throw an exception if the class name is null.

Parameters:

classname - The class name of interest.

Returns:

True if the class name has been registered, false otherwise.

Throws:

java.lang.NullPointerException - Thrown if the class name is null.

containsAbbreviation

public static boolean containsAbbreviation(java.lang.String abbreviation)

Determines whether the specified abbreviation has been registered already. Returns true if the abbreviation is in use, false if the abbreviation is not used. Note that this method will throw an exception if the abbreviation is null.

Parameters:

abbreviation - The abbreviation of interest.

Returns:

True if the abbreviation is in use already, false otherwise.

Throws:

java.lang.NullPointerException - Thrown if the abbreviation is null.