org.spectrumauctions.sats.core.util.instancehandling

Class InMemoryInstanceHandler

java.lang.Object

org.spectrumauctions.sats.core.util.instancehandling.InstanceHandler

org.spectrumauctions.sats.core.util.instancehandling.InMemoryInstanceHandler

public class InMemoryInstanceHandler
extends InstanceHandler

A fast instance handler implementation.
No files are written - all write methods are empty mocks.

The use of this handler is only recommended if no instances are serialized or deserialized.
Otherwise, id collisions may occure.

Author:

Michael Weiss

Method Summary

Modifier and Type	Method and Description
static InMemoryInstanceHandler	getInstance()
long	getNextPopulationId(long worldId) Returns a new population id The id is unique amongst all previously generated population ids with the same worldId.
long	getNextWorldId() Returns an new unused world id.
Collection<Long>	getPopulationIds(long worldId)
<T extends Bidder<?>> T	readBidder(Class<T> type, World world, long populationId, long bidderId) Used to deserialize a bidder, if its implementing class is known
<T extends Bidder<?>> T	readBidderWithUnknownType(Class<T> bidderSuperType, World world, long populationId, long bidderId) Used to deserialize a bidder, if its type is not exactly known, i.e., if there are different bidder implementations for this model.
<T extends Bidder<?>> Collection<T>	readPopulation(Class<T> type, World world, long populationId) Used to deserialize a set of bidders, if the implementing class of all bidders is known and the same
<T extends Bidder<?>> Collection<T>	readPopulationWithUnknownTypes(Class<T> bidderSuperType, World world, long populationId) Used to deserialize a set of bidders, if their type is not exactly known, i.e., if there are different bidder implementations for this model.
<T extends World> T	readWorld(Class<T> type, long world) Reads a world instance.
void	writeBidder(Bidder<?> bidder) Writes a new bidder instance.
void	writeWorld(World world) Writes a world instance.

Methods inherited from class org.spectrumauctions.sats.core.util.instancehandling.InstanceHandler

getDefaultHandler, setDefaultHandler

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static InMemoryInstanceHandler getInstance()

writeWorld

public void writeWorld(World world)

Description copied from class: InstanceHandler

Writes a world instance. If a world with the same id already is stored, it might be overwritten.

Specified by:

writeWorld in class InstanceHandler

Parameters:

world - the world to be written

writeBidder

public void writeBidder(Bidder<?> bidder)

Description copied from class: InstanceHandler

Writes a new bidder instance. If a bidder with the same world and population id already is stored, it might be overwritten.

Specified by:

writeBidder in class InstanceHandler

Parameters:

bidder - the bidder to be written

getPopulationIds

public Collection<Long> getPopulationIds(long worldId)

Specified by:

getPopulationIds in class InstanceHandler

Returns:

A collection containing all ids of the stored population for the requested world

readBidder

public <T extends Bidder<?>> T readBidder(Class<T> type,
                                          World world,
                                          long populationId,
                                          long bidderId)

Description copied from class: InstanceHandler

Used to deserialize a bidder, if its implementing class is known

Specified by:

readBidder in class InstanceHandler

Parameters:

type - the class of which a new instance should be created

world - the world the bidder lives in

populationId - the id of the population

bidderId - the id of the bidder

Returns:

the deserialized bidder

readPopulation

public <T extends Bidder<?>> Collection<T> readPopulation(Class<T> type,
                                                          World world,
                                                          long populationId)

Description copied from class: InstanceHandler

Used to deserialize a set of bidders, if the implementing class of all bidders is known and the same

Specified by:

readPopulation in class InstanceHandler

Parameters:

type - the class of which the new bidder instances should be created

world - the world the bidders live in

populationId - the id of the population

Returns:

the deserialized bidders

readBidderWithUnknownType

public <T extends Bidder<?>> T readBidderWithUnknownType(Class<T> bidderSuperType,
                                                         World world,
                                                         long populationId,
                                                         long bidderId)

Description copied from class: InstanceHandler

Used to deserialize a bidder, if its type is not exactly known, i.e., if there are different bidder implementations for this model.

Specified by:

readBidderWithUnknownType in class InstanceHandler

Parameters:

bidderSuperType - the deserialized bidder is either of class bidderSuperType or of a subclass of bidderSuperType

world - the world the bidder lives in

populationId - the id of the population

bidderId - the id of the bidder

Returns:

the deserialized bidder

readPopulationWithUnknownTypes

public <T extends Bidder<?>> Collection<T> readPopulationWithUnknownTypes(Class<T> bidderSuperType,
                                                                          World world,
                                                                          long populationId)

Description copied from class: InstanceHandler

Used to deserialize a set of bidders, if their type is not exactly known, i.e., if there are different bidder implementations for this model.

Specified by:

readPopulationWithUnknownTypes in class InstanceHandler

Parameters:

bidderSuperType - the deserialized bidder is either of class bidderSuperType or of a subclass of bidderSuperType

world - the world the bidders live in

populationId - the id of the population

Returns:

the deserialized bidders

getNextWorldId

public long getNextWorldId()

Description copied from class: InstanceHandler

Returns an new unused world id. The id is unique amongst all previously generated world ids.

Specified by:

getNextWorldId in class InstanceHandler

Returns:

an unused world id

getNextPopulationId

public long getNextPopulationId(long worldId)

Description copied from class: InstanceHandler

Returns a new population id The id is unique amongst all previously generated population ids with the same worldId.

Specified by:

getNextPopulationId in class InstanceHandler

Parameters:

worldId - The id of the world to which the new population will belong

Returns:

a new population id

readWorld

public <T extends World> T readWorld(Class<T> type,
                                     long world)

Description copied from class: InstanceHandler

Reads a world instance.

Specified by:

readWorld in class InstanceHandler