org.conqat.lib.commons.serialization.classes

Class SerializedClass

java.lang.Object

org.conqat.lib.commons.serialization.SerializedEntityBase

org.conqat.lib.commons.serialization.classes.SerializedClassBase

org.conqat.lib.commons.serialization.classes.SerializedClass

public class SerializedClass
extends SerializedClassBase

A serialized class.

Field Summary

Fields inherited from class org.conqat.lib.commons.serialization.classes.SerializedClassBase

superClassHandle

Fields inherited from class org.conqat.lib.commons.serialization.SerializedEntityBase

handle, pool

Constructor Summary

Constructors

Constructor and Description
SerializedClass(java.io.DataInputStream din, SerializedEntityPool pool, SerializedEntityParser parser) Constructor.
SerializedClass(java.lang.String name, int serialVersionUid, byte classDescriptionFlags, SerializedEntityPool pool) Direct constructor.

Method Summary

Modifier and Type	Method and Description
void	addField(SerializedFieldBase newField) Adds a field to this class.
boolean	containsField(java.lang.String name) Returns whether this class has a field with the given name.
static SerializedClass	createSimpleEnum(SerializedEntityPool pool, java.lang.String enumName) Factory method for creating a new enum class.
byte	getClassDescriptionFlags() Returns the class description flags.
SerializedFieldBase	getField(java.lang.String name) Returns the field by name (or null if not found).
UnmodifiableList<SerializedFieldBase>	getFields() Returns the fields of this class.
java.lang.String	getName() Returns the name.
long	getSerialVersionUid() Returns the serial version.
boolean	hasBlockData() Returns whether this class stores block data (only relevant for externalizable).
boolean	hasWriteMethod() Returns whether this class has a custom write method (only relevant for serializable).
boolean	isExternalizable() Returns whether this is an externalizable class.
boolean	isSerializable() Returns whether this is a serializable class.
protected void	parseClass(java.io.DataInputStream din, SerializedEntityPool pool, SerializedEntityParser parser) Parses the class content.
void	removeField(java.lang.String name) Removes the field of given name from this class.
protected void	serializeClass(java.io.DataOutputStream dos, SerializedEntitySerializer serializer) Serializes the class part of this entity.
void	setName(java.lang.String name) Sets the name.
void	setSerialVersionUid(long serialVersionUid) Sets the serial version uid.
java.lang.String	toString()

Methods inherited from class org.conqat.lib.commons.serialization.classes.SerializedClassBase

getSuperClassHandle, serializeContent

Methods inherited from class org.conqat.lib.commons.serialization.SerializedEntityBase

getHandle, serialize

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializedClass

public SerializedClass(java.io.DataInputStream din,
                       SerializedEntityPool pool,
                       SerializedEntityParser parser)
                throws java.io.IOException

Constructor.

Throws:

java.io.IOException

SerializedClass

public SerializedClass(java.lang.String name,
                       int serialVersionUid,
                       byte classDescriptionFlags,
                       SerializedEntityPool pool)

Direct constructor.

Method Detail

parseClass

protected void parseClass(java.io.DataInputStream din,
                          SerializedEntityPool pool,
                          SerializedEntityParser parser)
                   throws java.io.IOException

Parses the class content. This is called from the constructor, so fields of sub classes might not be initialized.

Specified by:

parseClass in class SerializedClassBase

Throws:

java.io.IOException

serializeClass

protected void serializeClass(java.io.DataOutputStream dos,
                              SerializedEntitySerializer serializer)
                       throws java.io.IOException

Serializes the class part of this entity.

Specified by:

serializeClass in class SerializedClassBase

Throws:

java.io.IOException

getName

public java.lang.String getName()

Returns the name.

setName

public void setName(java.lang.String name)

Sets the name.

getSerialVersionUid

public long getSerialVersionUid()

Returns the serial version.

setSerialVersionUid

public void setSerialVersionUid(long serialVersionUid)

Sets the serial version uid.

getClassDescriptionFlags

public byte getClassDescriptionFlags()

Returns the class description flags.

getFields

public UnmodifiableList<SerializedFieldBase> getFields()

Returns the fields of this class.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getField

public SerializedFieldBase getField(java.lang.String name)

Returns the field by name (or null if not found).

containsField

public boolean containsField(java.lang.String name)

Returns whether this class has a field with the given name.

addField

public void addField(SerializedFieldBase newField)

Adds a field to this class. Note that the instances of this class have to be adjusted accordingly, otherwise you will get exceptions during serialization.

removeField

public void removeField(java.lang.String name)

Removes the field of given name from this class. Note that the instances of this class have to be adjusted accordingly, otherwise you will get exceptions during serialization.

isExternalizable

public boolean isExternalizable()

Returns whether this is an externalizable class.

isSerializable

public boolean isSerializable()

Returns whether this is a serializable class.

hasWriteMethod

public boolean hasWriteMethod()

Returns whether this class has a custom write method (only relevant for serializable).

hasBlockData

public boolean hasBlockData()

Returns whether this class stores block data (only relevant for externalizable).

createSimpleEnum

public static SerializedClass createSimpleEnum(SerializedEntityPool pool,
                                               java.lang.String enumName)

Factory method for creating a new enum class.