org.conqat.lib.commons.serialization

Class SerializedEntityPool

java.lang.Object

org.conqat.lib.commons.serialization.SerializedEntityPool

public class SerializedEntityPool
extends java.lang.Object

A class that manages a set of serialized entities (objects and classes) as well as secondary entities referenced by them.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NULL_HANDLE The handle representing the null value.

Constructor Summary

Constructors

Constructor and Description
SerializedEntityPool()

Method Summary

Modifier and Type	Method and Description
void	assertAllPlainClassNamesMatch(java.util.function.Function<java.lang.String,java.lang.Boolean> matcher, java.lang.String message) Asserts that all serialized class names are matched by the given function.
boolean	containsHandle(int handle) Returns whether the given handle is known to this pool.
SerializedClass	findClass(java.lang.String name) Attempts to find a class by its name.
<T extends SerializedEntityBase> java.util.List<T>	getEntities(java.lang.Class<T> expectedType) Return all entities anywhere in the object graph of the given type.
<T extends SerializedEntityBase> T	getEntity(int handle, java.lang.Class<T> expectedType) Returns an entity of specific expected type.
java.util.List<SerializedEntityBase>	getRootEntities() Returns the root entities in this pool.
<T extends SerializedEntityBase> java.util.List<T>	getRootEntities(java.lang.Class<T> expectedType) Return all root entities of the given type.
void	registerRootHandle(int handle) Adds a handle as root.
void	renameClass(java.lang.String oldName, java.lang.String newName) Renames the given class if found.
void	reset() Resets the pool to an empty state.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_HANDLE

public static final int NULL_HANDLE

The handle representing the null value.

See Also:

Constant Field Values

Constructor Detail

SerializedEntityPool

public SerializedEntityPool()

Method Detail

reset

public void reset()

Resets the pool to an empty state.

containsHandle

public boolean containsHandle(int handle)

Returns whether the given handle is known to this pool.

getEntity

public <T extends SerializedEntityBase> T getEntity(int handle,
                                                    java.lang.Class<T> expectedType)
                                             throws java.io.IOException

Returns an entity of specific expected type. Throws an exception if the handle is not known or of different type.

Throws:

java.io.IOException

getEntities

public <T extends SerializedEntityBase> java.util.List<T> getEntities(java.lang.Class<T> expectedType)
                                                               throws java.io.IOException

Return all entities anywhere in the object graph of the given type.

Throws:

java.io.IOException

getRootEntities

public <T extends SerializedEntityBase> java.util.List<T> getRootEntities(java.lang.Class<T> expectedType)
                                                                   throws java.io.IOException

Return all root entities of the given type.

Throws:

java.io.IOException

getRootEntities

public java.util.List<SerializedEntityBase> getRootEntities()
                                                     throws java.io.IOException

Returns the root entities in this pool.

Throws:

java.io.IOException

registerRootHandle

public void registerRootHandle(int handle)
                        throws java.io.IOException

Adds a handle as root.

Throws:

java.io.IOException

findClass

public SerializedClass findClass(java.lang.String name)

Attempts to find a class by its name. Returns null if not found.

renameClass

public void renameClass(java.lang.String oldName,
                        java.lang.String newName)

Renames the given class if found.

assertAllPlainClassNamesMatch

public void assertAllPlainClassNamesMatch(java.util.function.Function<java.lang.String,java.lang.Boolean> matcher,
                                          java.lang.String message)

Asserts that all serialized class names are matched by the given function.