Package com.djrapitops.plan.extension

Class ExtensionSvc

java.lang.Object

com.djrapitops.plan.extension.ExtensionSvc

All Implemented Interfaces:

ExtensionService

@Singleton
public class ExtensionSvc
extends Object
implements ExtensionService

Implementation for ExtensionService.

Nested Class Summary

Nested classes/interfaces inherited from interface com.djrapitops.plan.extension.ExtensionService

ExtensionService.Holder

Constructor Summary

Constructors

Constructor	Description
ExtensionSvc(PlanConfig config, DBSystem dbSystem, ComponentSvc componentService, ServerInfo serverInfo, Processing processing, ExtensionRegister extensionRegister, UUIDUtility uuidUtility, net.playeranalytics.plugin.server.PluginLogger logger, ErrorLogger errorLogger)

Method Summary

Modifier and Type	Method	Description
void	disableUpdates()
ExtensionDataBuilder	newExtensionDataBuilder(DataExtension extension)	Obtain a new ExtensionDataBuilder, it is recommended to use DataExtension.newExtensionDataBuilder().
void	register()
Optional<Caller>	register(DataExtension dataExtension)	Register your DataExtension implementation.
void	registerExtensions()
void	unregister(DataExtension extension)	Unregister your DataExtension implementation.
void	updatePlayerValues(DataValueGatherer gatherer, UUID playerUUID, String playerName, CallEvents event)
void	updatePlayerValues(UUID playerUUID, String playerName, CallEvents event)
void	updateServerValues(CallEvents event)
void	updateServerValues(DataValueGatherer gatherer, CallEvents event)

Methods inherited from class java.lang.Object

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

Constructor Details

ExtensionSvc

@Inject
public ExtensionSvc(PlanConfig config,
 DBSystem dbSystem,
 ComponentSvc componentService,
 ServerInfo serverInfo,
 Processing processing,
 ExtensionRegister extensionRegister,
 UUIDUtility uuidUtility,
 net.playeranalytics.plugin.server.PluginLogger logger,
 ErrorLogger errorLogger)

Method Details

register

public void register()

registerExtensions

public void registerExtensions()

register

public Optional<Caller> register(DataExtension dataExtension)

Description copied from interface: ExtensionService

Register your DataExtension implementation.

You can use ExtensionExtractor.validateAnnotations() in your Unit Tests to prevent IllegalArgumentExceptions here at runtime.

Specified by:

register in interface ExtensionService

Parameters:

dataExtension - Your DataExtension implementation, see DataExtension for requirements.

Returns:

Optional Caller that can be used to call for data update in Plan database manually - If the Optional is not present the user has disabled the extension in Plan config.

unregister

public void unregister(DataExtension extension)

Description copied from interface: ExtensionService

Unregister your DataExtension implementation.

This method should be used if calling methods on the DataExtension suddenly becomes unavailable, due to plugin disable for example.

Specified by:

unregister in interface ExtensionService

Parameters:

extension - Your DataExtension implementation that was registered before.

newExtensionDataBuilder

public ExtensionDataBuilder newExtensionDataBuilder(DataExtension extension)

Description copied from interface: ExtensionService

Obtain a new ExtensionDataBuilder, it is recommended to use DataExtension.newExtensionDataBuilder().

Requires Capability DATA_EXTENSION_BUILDER_API

Specified by:

newExtensionDataBuilder in interface ExtensionService

Parameters:

extension - Extension for which this builder is.

Returns:

a new builder.

updatePlayerValues

public void updatePlayerValues(UUID playerUUID,
 String playerName,
 CallEvents event)

updatePlayerValues

public void updatePlayerValues(DataValueGatherer gatherer,
 UUID playerUUID,
 String playerName,
 CallEvents event)

updateServerValues

public void updateServerValues(CallEvents event)

updateServerValues

public void updateServerValues(DataValueGatherer gatherer,
 CallEvents event)

disableUpdates

public void disableUpdates()