javax.measure.spi

Class ServiceProvider

java.lang.Object

javax.measure.spi.ServiceProvider

public abstract class ServiceProvider
extends java.lang.Object

Service Provider for Units of Measurement services.

All the methods in this class are safe to use by multiple concurrent threads.

Since:

1.0

Version:

1.1, March 29, 2018

Author:

Werner Keil, Martin Desruisseaux

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServiceProvider() Creates a new service provider.

Method Summary

Modifier and Type	Method and Description
static java.util.List<ServiceProvider>	available() Returns the list of available service providers.
static ServiceProvider	current() Returns the current ServiceProvider.
abstract FormatService	getFormatService() Returns the service to obtain UnitFormat and QuantityFormat or null if none.
int	getPriority() This method allows to define a priority for a registered ServiceProvider instance.
abstract <Q extends Quantity<Q>> QuantityFactory<Q>	getQuantityFactory(java.lang.Class<Q> quantity) Return a factory for this Quantity.
abstract SystemOfUnitsService	getSystemOfUnitsService() Returns the service to obtain a SystemOfUnits, or null if none.
abstract UnitFormatService	getUnitFormatService() Deprecated. Use #getFormatService(), this method will be removed in a future version, it is here for backward compatibility only.
static ServiceProvider	setCurrent(ServiceProvider provider) Replaces the current ServiceProvider.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceProvider

protected ServiceProvider()

Creates a new service provider. Only to be used by subclasses.

Method Detail

getPriority

public int getPriority()

This method allows to define a priority for a registered ServiceProvider instance. When multiple providers are registered in the system the provider with the highest priority value is taken.

Returns:

the provider's priority (default is 0).

getSystemOfUnitsService

public abstract SystemOfUnitsService getSystemOfUnitsService()

Returns the service to obtain a SystemOfUnits, or null if none.

Returns:

the service to obtain a SystemOfUnits, or null.

getUnitFormatService

public abstract UnitFormatService getUnitFormatService()

Deprecated. Use #getFormatService(), this method will be removed in a future version, it is here for backward compatibility only.

Returns the service to obtain a UnitFormat, or null if none.

Returns:

the service to obtain a UnitFormat, or null.

getFormatService

public abstract FormatService getFormatService()

Returns the service to obtain UnitFormat and QuantityFormat or null if none.

Returns:

the service to obtain a UnitFormat and QuantityFormat, or null.

Since:

2.0

getQuantityFactory

public abstract <Q extends Quantity<Q>> QuantityFactory<Q> getQuantityFactory(java.lang.Class<Q> quantity)

Return a factory for this Quantity.

Type Parameters:

Q - the type of the Quantity result

Parameters:

quantity - the quantity

Returns:

the QuantityFactory

available

public static java.util.List<ServiceProvider> available()

Returns the list of available service providers.

Returns:

all available service providers.

current

public static ServiceProvider current()

Returns the current ServiceProvider. If necessary the ServiceProvider will be lazily loaded.

If there are no providers available, an IllegalStateException is thrown, otherwise the provider with the highest priority is used or the one explicitly designated via setCurrent(ServiceProvider) .

Returns:

the ServiceProvider used.

Throws:

java.lang.IllegalStateException - if no ServiceProvider has been found.

See Also:

getPriority(), setCurrent(ServiceProvider)

setCurrent

public static ServiceProvider setCurrent(ServiceProvider provider)

Replaces the current ServiceProvider.

Parameters:

provider - the new ServiceProvider

Returns:

the replaced provider, or null.