com.comphenix.xp.history

Class HistoryProviders

java.lang.Object

com.comphenix.xp.extra.ServiceProvider<HistoryService>

com.comphenix.xp.history.HistoryProviders

public class HistoryProviders
extends ServiceProvider<HistoryService>

Registry of history (block change logging) providers.

The default service setting is ignored.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.SortedSet<HistoryService>	speedOrder Services sorted by lookup speed.

Fields inherited from class com.comphenix.xp.extra.ServiceProvider

defaultServiceName, disabledLookup, nameLookup

Constructor Summary

Constructors

Constructor and Description
HistoryProviders()

Method Summary

Methods

Modifier and Type	Method and Description
MemoryService	getMemoryService()
java.lang.Boolean	hasPlayerHistory(org.bukkit.Location block, boolean acceptGuesses, Debugger debugger) Determines whether or not a block has been placed by a player, using the registered service providers in order of lookup speed.
java.lang.Boolean	hasPlayerHistory(org.bukkit.Location block, boolean acceptGuesses, ErrorHandler<java.lang.Exception> errorHandler) Determines whether or not a block has been placed by a player, using the registered service providers in order of lookup speed.
HistoryService	register(HistoryService service) Registers a service in the system.
HistoryService	unregister(HistoryService service) Unregisters a particular service.

Methods inherited from class com.comphenix.xp.extra.ServiceProvider

containsService, enableAll, getByName, getDefaultName, getDefaultService, getEnabledServices, getRegisteredServices, isEnabled, isEnabled, setByName, setDefaultName, setEnabled, setEnabled, unregister

Methods inherited from class java.lang.Object

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

Field Detail

speedOrder

protected transient java.util.SortedSet<HistoryService> speedOrder

Services sorted by lookup speed.

Constructor Detail

HistoryProviders

public HistoryProviders()

Method Detail

getMemoryService

public MemoryService getMemoryService()

hasPlayerHistory

public java.lang.Boolean hasPlayerHistory(org.bukkit.Location block,
                                 boolean acceptGuesses,
                                 Debugger debugger)

Determines whether or not a block has been placed by a player, using the registered service providers in order of lookup speed.

If no service provider could accurately answer the query, the function returns NULL.

Parameters:

block - - block to search for.

acceptGuesses - - whether or not probabilistic answers are acceptable.

debugger - - debugger that handles errors produced by any history service.

Returns:

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

hasPlayerHistory

public java.lang.Boolean hasPlayerHistory(org.bukkit.Location block,
                                 boolean acceptGuesses,
                                 ErrorHandler<java.lang.Exception> errorHandler)

Determines whether or not a block has been placed by a player, using the registered service providers in order of lookup speed.

If no service provider could accurately answer the query, the function returns NULL.

Parameters:

block - - block to search for.

acceptGuesses - - whether or not probabilistic answers are acceptable.

errorHandler - - reports errors from individual history services.

Returns:

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

register

public HistoryService register(HistoryService service)

Description copied from class: ServiceProvider

Registers a service in the system.

Overrides:

register in class ServiceProvider<HistoryService>

Parameters:

service - - the service to register.

Returns:

The previously registered service with this name, or NULL otherwise.

unregister

public HistoryService unregister(HistoryService service)

Description copied from class: ServiceProvider

Unregisters a particular service.

Overrides:

unregister in class ServiceProvider<HistoryService>

Parameters:

service - - the service to unregister.

Returns:

The service that was unregistered, or NULL if this service has already been unregistered.