Package javax.measure.spi

Interface FormatService

All Superinterfaces:

UnitFormatService

public interface FormatService
extends UnitFormatService

This interface represent the service to obtain instances of UnitFormat and QuantityFormat.

Since:

2.0

Version:

1.0.1, November 9, 2018

Author:

Werner Keil

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FormatService.FormatType

Method Summary

Modifier and Type	Method	Description
Set<String>	getAvailableFormatNames(FormatService.FormatType type)	Gets a list with available format names of a given type for this format service.
QuantityFormat	getQuantityFormat()	Returns the default quantity format.
QuantityFormat	getQuantityFormat(String name)	Returns the quantity format having the specified name or null if none.

Methods inherited from interface javax.measure.spi.UnitFormatService

getAvailableFormatNames, getUnitFormat, getUnitFormat

Method Detail

getQuantityFormat

QuantityFormat getQuantityFormat()

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

Returns:

the default QuantityFormat implementation.

getQuantityFormat

QuantityFormat getQuantityFormat(String name)

Returns the quantity format having the specified name or null if none. For example (@code getQuantityFormat("Simple")} to return the simple QuantityFormat implementation.

Parameters:

name - the name of the format.

Returns:

the corresponding quantity format.

getAvailableFormatNames

Set<String> getAvailableFormatNames(FormatService.FormatType type)

Gets a list with available format names of a given type for this format service.

Parameters:

type - the FormatService.FormatType

Returns:

list of available formats, never null.