agi.foundation.tracking

(agi.foundation.tracking-2024r3.jar)

Class TrackingTypeArchiverCollection

java.lang.Object

agi.foundation.tracking.TrackingTypeArchiverCollection

All Implemented Interfaces:

IFreezable

public class TrackingTypeArchiverCollection
extends Object
implements IFreezable

A collection of TrackingTypeArchivers. It is safe to use all methods of this class from multiple threads simultaneously.

Constructor Summary

Constructors

Constructor and Description
TrackingTypeArchiverCollection() Initializes a new instance.
TrackingTypeArchiverCollection(Map<Class<?>,TrackingTypeArchiver> archivers) Initializes a new instance with a collection of TrackingTypeArchivers.
TrackingTypeArchiverCollection(TrackingTypeArchiverCollection collection) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
void	add(Class<?> type, TrackingTypeArchiver archiver) Adds an archiver for a complex type composed of multiple primitives.
<T> void	addEnumeration(TypeLiteral<T> typeLiteralT) Adds an archiver for an enumeration type that should be archived directly.
void	freeze() Freezes this object.
TrackingTypeArchiver	getArchiverForType(Class<?> type) Gets the archiver for the specified type.
boolean	getIsFrozen() Gets a value indicating whether this object is frozen.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrackingTypeArchiverCollection

public TrackingTypeArchiverCollection()

Initializes a new instance. The new collection will be filled with default TrackingTypeArchivers for all primitive types.

TrackingTypeArchiverCollection

public TrackingTypeArchiverCollection(@Nonnull
                                      TrackingTypeArchiverCollection collection)

Initializes a new instance as a copy of an existing instance.

Parameters:

collection - The existing instance to copy.

Throws:

ArgumentNullException - Thrown when collection is null.

TrackingTypeArchiverCollection

public TrackingTypeArchiverCollection(@Nonnull
                                      Map<Class<?>,TrackingTypeArchiver> archivers)

Initializes a new instance with a collection of TrackingTypeArchivers.

Parameters:

archivers - The collection of archivers.

Throws:

ArgumentNullException - Thrown when archivers is null.

Method Detail

addEnumeration

public final <T> void addEnumeration(TypeLiteral<T> typeLiteralT)

Adds an archiver for an enumeration type that should be archived directly.

Type Parameters:

T - The enumeration type to archive directly.

Parameters:

typeLiteralT - A TypeLiteral object representing the generic type T.

add

public final void add(@Nonnull
                      Class<?> type,
                      @Nonnull
                      TrackingTypeArchiver archiver)

Adds an archiver for a complex type composed of multiple primitives.

Parameters:

type - The type for which to add an archiver.

archiver - The archiver for the type.

Throws:

ArgumentNullException - Thrown when type or archiver is null.

getArchiverForType

@Nonnull
public final TrackingTypeArchiver getArchiverForType(@Nonnull
                                                               Class<?> type)

Gets the archiver for the specified type.

Parameters:

type - The type for which to obtain an archiver.

Returns:

The archiver.

Throws:

IllegalStateException - Thrown when no archiver is registered for the specified type.

ArgumentNullException - Thrown when type is null.

freeze

public final void freeze()

Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.

Specified by:

freeze in interface IFreezable

getIsFrozen

public final boolean getIsFrozen()

Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.

Specified by:

getIsFrozen in interface IFreezable