jdeserialize

Class contentbase

java.lang.Object

jdeserialize.contentbase

All Implemented Interfaces:

content

Direct Known Subclasses:

arrayobj, blockdata, classdesc, classobj, enumobj, exceptionstate, instance, stringobj

public class contentbase
extends java.lang.Object
implements content

Provides a skeleton content implementation.

Field Summary

Fields

Modifier and Type	Field and Description
int	handle
boolean	isExceptionObject
protected contenttype	type

Fields inherited from interface jdeserialize.content

INDENT, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
contentbase(contenttype type)

Method Summary

Modifier and Type	Method and Description
int	getHandle() Get the numeric handle by which this object was referred to in the object stream.
contenttype	getType()
boolean	isExceptionObject() Tells whether or not this object is an exception that was caught during serialization.
void	setIsExceptionObject(boolean value) Sets the flag that tells whether or not this object is an exception that was caught during serialization.
java.lang.String	toJson(java.lang.String indetation, java.util.Map<classdesc,java.util.Map<field,java.lang.Object>> fielddata, boolean child) Analogy for toString method; however, outputs its string in json formatting.
void	validate() Performs extra object-specific validity checks.

Methods inherited from class java.lang.Object

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

Field Detail

handle

public int handle

isExceptionObject

public boolean isExceptionObject

type

protected contenttype type

Constructor Detail

contentbase

public contentbase(contenttype type)

Method Detail

isExceptionObject

public boolean isExceptionObject()

Description copied from interface: content

Tells whether or not this object is an exception that was caught during serialization.

Note: Not every Throwable or Exception in the stream will have this flag set to true; only those which were thrown during serialization will

Specified by:

isExceptionObject in interface content

Returns:

true iff the object was an exception thrown during serialization

setIsExceptionObject

public void setIsExceptionObject(boolean value)

Description copied from interface: content

Sets the flag that tells whether or not this object is an exception that was caught during serialization.

Specified by:

setIsExceptionObject in interface content

Parameters:

value - the new value to use

getType

public contenttype getType()

Specified by:

getType in interface content

Returns:

the type of instance represented by this object.

getHandle

public int getHandle()

Description copied from interface: content

Get the numeric handle by which this object was referred to in the object stream. These handles are used internally by Object{Output,Input}Stream as a mechanism to avoid costly duplication.

CAUTION: they are *not* necessarily unique across all objects in a given stream! If an exception was thrown during serialization (which is most likely to happen during a serialized objct's writeObject() implementation), then the stream resets before and after the exception is serialized.

Specified by:

getHandle in interface content

Returns:

the handle assigned in the stream

validate

public void validate()
              throws ValidityException

Description copied from interface: content

Performs extra object-specific validity checks.

Specified by:

validate in interface content

Throws:

ValidityException - if the object's state is invalid

toJson

public java.lang.String toJson(java.lang.String indetation,
                               java.util.Map<classdesc,java.util.Map<field,java.lang.Object>> fielddata,
                               boolean child)

Description copied from interface: content

Analogy for toString method; however, outputs its string in json formatting. Returns the exact json representation of object with indentation.

Inherited by multiple classes via contentbase, often calls itself for another object

Specified by:

toJson in interface content

Parameters:

indetation - starting indentation for json output

fielddata - used when calling this method for inner instances so the instance has info about its variables. Instance info is saved in another content space than info about its field variables, so it must be provided by parameter to inner instances

child - tells that the instance is child of another because of indentation

Returns:

The string in json format representing this instance