com.comphenix.xp.history

Interface HistoryService

All Superinterfaces:

Service

All Known Implementing Classes:

HawkeyeService, LogBlockService, MemoryService

public interface HistoryService
extends Service

Represents a store of previous player actions.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HistoryService.LookupSpeed The lookup speed of a particular service.

Method Summary

Methods

Modifier and Type	Method and Description
HistoryService.LookupSpeed	getLookupSpeed() Retrieve the lookup (read) speed.
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.

Methods inherited from interface com.comphenix.xp.extra.Service

getServiceName

Method Detail

getLookupSpeed

HistoryService.LookupSpeed getLookupSpeed()

Retrieve the lookup (read) speed.

Returns:

How quickly values can be read from this service.

hasFalsePositives

boolean hasFalsePositives()

Whether or not this service may return false positives.

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

Returns:

TRUE if this service returns false positives, FALSE otherwise.

hasFalseNegatives

boolean hasFalseNegatives()

Whether or not this service returns false negatives.

Returns:

TRUE if this service returns false negatives, FALSE otherwise.

hasPlayerHistory

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

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 hasFalsePositives() or hasFalseNegatives()).

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