com.comphenix.xp.history

Class MemoryService

java.lang.Object

com.comphenix.xp.history.MemoryService

All Implemented Interfaces:

Service, HistoryService

public class MemoryService
extends java.lang.Object
implements HistoryService

A simple memory-based history service.

Author:

Kristian

Nested Class Summary

Nested classes/interfaces inherited from interface com.comphenix.xp.history.HistoryService

HistoryService.LookupSpeed

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
MemoryService(int timeout) Constructs a simple memory-based history.
MemoryService(int maximumSize, int timeout) Constructs a simple memory-based history.

Method Summary

Methods

Modifier and Type	Method and Description
HistoryService.LookupSpeed	getLookupSpeed() Retrieve the lookup (read) speed.
java.lang.String	getServiceName() Retrieves a unique string identifying this service.
boolean	hasFalseNegatives() Whether or not this service returns false negatives.
boolean	hasFalsePositives() Whether or not this service may return false positives.
java.lang.Boolean	hasPlayerHistory(org.bukkit.Location blockLocation) Determines whether or not a block has been placed by a player.
void	onBlockPlaceEvent(org.bukkit.event.block.BlockPlaceEvent event) Called by ExperienceBlockListener when a block has been placed by a plyer.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

MemoryService

public MemoryService(int maximumSize,
             int timeout)

Constructs a simple memory-based history.

Parameters:

maximumSize - - maximum number of block changes to store.

timeout - - number of seconds until a location is removed from the history.

MemoryService

public MemoryService(int timeout)

Constructs a simple memory-based history.

Parameters:

timeout - - number of seconds until a location is removed from the history.

Method Detail

getServiceName

public java.lang.String getServiceName()

Description copied from interface: Service

Retrieves a unique string identifying this service. May also be used during parsing.

Note that this identifier must conform to an ENUM convention: upper case only, underscore for space.

A service MUST not alter its identifier once it has been registered.

Specified by:

getServiceName in interface Service

Returns:

A unique reward ID.

onBlockPlaceEvent

public void onBlockPlaceEvent(org.bukkit.event.block.BlockPlaceEvent event)

Called by ExperienceBlockListener when a block has been placed by a plyer.

Parameters:

event - - even to be notified about.

hasPlayerHistory

public java.lang.Boolean hasPlayerHistory(org.bukkit.Location blockLocation)
                                   throws HistoryException

Description copied from interface: HistoryService

Determines whether or not a block has been placed by a player.

A service should return NULL if it cannot decide on a value, OR report that its return value is always probabilistic (using HistoryService.hasFalsePositives() or HistoryService.hasFalseNegatives()).

Specified by:

hasPlayerHistory in interface HistoryService

Parameters:

blockLocation - - location of the block in question.

Returns:

TRUE if the given block was placed by a player, FALSE if it was placed naturally, NULL if unknown.

Throws:

HistoryException

getLookupSpeed

public HistoryService.LookupSpeed getLookupSpeed()

Description copied from interface: HistoryService

Retrieve the lookup (read) speed.

Specified by:

getLookupSpeed in interface HistoryService

Returns:

How quickly values can be read from this service.

hasFalsePositives

public boolean hasFalsePositives()

Description copied from interface: HistoryService

Whether or not this service may return false positives.

If it does, HistoryProviders may decide to inquire other services, if at all possible.

Specified by:

hasFalsePositives in interface HistoryService

Returns:

TRUE if this service returns false positives, FALSE otherwise.

hasFalseNegatives

public boolean hasFalseNegatives()

Description copied from interface: HistoryService

Whether or not this service returns false negatives.

Specified by:

hasFalseNegatives in interface HistoryService

Returns:

TRUE if this service returns false negatives, FALSE otherwise.