Package javax.measure.spi

Interface UnitFormatService

All Known Subinterfaces:

FormatService

public interface UnitFormatService

This interface represent the service to obtain UnitFormat instances.

Note: This parent interface remains separate for backward-compatibility, it will be merged into FormatService in a future version.

Since:

1.0

Version:

1.2.2, March 11, 2019

Author:

Jean-Marie Dautelle, Werner Keil

Method Summary

Modifier and Type	Method	Description
Set<String>	getAvailableFormatNames()	Deprecated. use in FormatService instead.
UnitFormat	getUnitFormat()	Returns the default unit format.
UnitFormat	getUnitFormat(String name)	Returns the unit format having the specified name or null if none.

Method Detail

getUnitFormat

UnitFormat getUnitFormat()

Returns the default unit format. It is up to implementations what to consider a suitable default. For some (locale-sensitive) implementations it may be a unit format based on Locale.current() while others may return getUnitFormat("Simple") or getUnitFormat("ISO").

Returns:

the default UnitFormat implementation.

getUnitFormat

UnitFormat getUnitFormat(String name)

Returns the unit format having the specified name or null if none. For example getUnitFormat("Simple") to return a simple UnitFormat implementation.

Parameters:

name - the name of the format.

Returns:

the corresponding unit format.

getAvailableFormatNames

Set<String> getAvailableFormatNames()

Deprecated. use in FormatService instead.

Gets a list with available format names for this format service.

Returns:

list of available formats, never null.