org.spongepowered.api.event.service

Interface ChangeServiceProviderEvent

All Superinterfaces:

Event

public interface ChangeServiceProviderEvent
extends Event

Fired when the provider has been changed for a service in the ServiceManager.

This event is fired after the replacement has taken place. Calling ServiceManager.provideUnchecked(Class) with the service will return getNewProviderRegistration().

This can occur when a provider is registered for a service for the first time, or when the provider for a service is replaced.

Method Summary

Modifier and Type	Method and Description
default Object	getNewProvider() Gets the new provider being registered.
ProviderRegistration<?>	getNewProviderRegistration() Gets the new provider registration for the service.
Optional<ProviderRegistration<?>>	getPreviousProviderRegistration() Gets the previous provider registration for the service, if available.
default Class<?>	getService() Gets the service that a provider is being registered for.
default boolean	isReplacement() Gets whether a previous provider existed, which was replaced by the new provider.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

getPreviousProviderRegistration

Optional<ProviderRegistration<?>> getPreviousProviderRegistration()

Gets the previous provider registration for the service, if available.

If a provider is being registered for the first time for the service, this will return Optional.empty().

If this is present, then it will always have the same provider as getNewProviderRegistration().

Returns:

The previous provider registration, if available

getNewProviderRegistration

ProviderRegistration<?> getNewProviderRegistration()

Gets the new provider registration for the service.

Returns:

The new provider registration

isReplacement

default boolean isReplacement()

Gets whether a previous provider existed, which was replaced by the new provider.

Returns:

Whether a provider was replaced.

getService

default Class<?> getService()

Gets the service that a provider is being registered for.

Returns:

The service

getNewProvider

default Object getNewProvider()

Gets the new provider being registered.

Returns:

The provider