Package com.tameif.tame.lang

Interface StateSaveable

All Known Implementing Classes:

TContainerContext, TElementContext, TObjectContext, TOwnershipMap, TPlayerContext, TRoomContext, TWorldContext

public interface StateSaveable

Describes an object whose state that can be saved/loaded.

Author:

Matthew Tropiano

Method Summary

Modifier and Type	Method and Description
default void	fromStateBytes(TAMEModule module, java.util.Map<java.lang.Long,Value> referenceMap, byte[] data) Reads this object's state representation from a byte array.
void	readStateBytes(TAMEModule module, java.util.Map<java.lang.Long,Value> referenceMap, java.io.InputStream in) Imports this object's state from bytes.
default byte[]	toStateBytes(TAMEModule module, java.util.concurrent.atomic.AtomicLong referenceCounter, java.util.Map<java.lang.Object,java.lang.Long> referenceSet) Gets this object's state representation as bytes.
void	writeStateBytes(TAMEModule module, java.util.concurrent.atomic.AtomicLong referenceCounter, java.util.Map<java.lang.Object,java.lang.Long> referenceSet, java.io.OutputStream out) Exports this object's state to bytes.

Method Detail

writeStateBytes

void writeStateBytes(TAMEModule module,
                     java.util.concurrent.atomic.AtomicLong referenceCounter,
                     java.util.Map<java.lang.Object,java.lang.Long> referenceSet,
                     java.io.OutputStream out)
              throws java.io.IOException

Exports this object's state to bytes.

Parameters:

module - the source module for reference.

referenceCounter - the reference counter to use for when unique values are seen.

referenceSet - the reference set to use for "seen" value references - maps object reference to counter value.

out - the output stream to write to.

Throws:

java.io.IOException - if a write problem occurs.

readStateBytes

void readStateBytes(TAMEModule module,
                    java.util.Map<java.lang.Long,Value> referenceMap,
                    java.io.InputStream in)
             throws java.io.IOException

Imports this object's state from bytes.

Parameters:

module - the source module for reference.

referenceMap - the reference map to use for "seen" value references.

in - the input stream to read from.

Throws:

java.io.IOException - if a read problem occurs.

toStateBytes

default byte[] toStateBytes(TAMEModule module,
                            java.util.concurrent.atomic.AtomicLong referenceCounter,
                            java.util.Map<java.lang.Object,java.lang.Long> referenceSet)
                     throws java.io.IOException

Gets this object's state representation as bytes.

Parameters:

module - the source module for reference.

referenceCounter - the reference counter to use for when unique values are seen.

referenceSet - the reference set to use for "seen" value references - maps object reference to counter value.

Returns:

the byte array of state bytes.

Throws:

java.io.IOException - if a write problem occurs.

fromStateBytes

default void fromStateBytes(TAMEModule module,
                            java.util.Map<java.lang.Long,Value> referenceMap,
                            byte[] data)
                     throws java.io.IOException

Reads this object's state representation from a byte array.

Parameters:

module - the source module for reference.

referenceMap - the reference map to use for "seen" value references.

data - the data to read.

Throws:

java.io.IOException - if a read problem occurs.