com.ibm.icu.message2

Class Mf2FunctionRegistry

java.lang.Object

com.ibm.icu.message2.Mf2FunctionRegistry

Deprecated.

This API is for technology preview only.

@Deprecated
public class Mf2FunctionRegistry
extends Object

This class is used to register mappings between various function names and the factories that can create those functions.

For example to add formatting for a Person object one would need to:

• write a function (class, lambda, etc.) that does the formatting proper (implementing Formatter)
• write a factory that creates such a function (implementing FormatterFactory)
• add a mapping from the function name as used in the syntax (for example "person") to the factory
• optionally add a mapping from the class to format (...Person.class) to the formatter name ("person"), so that one can use a placeholder in the message without specifying a function (for example "... {$me} ..." instead of "... {$me :person} ...", if the class of $me is an instanceof Person).

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mf2FunctionRegistry.Builder Deprecated. This API is for technology preview only.

Method Summary

Modifier and Type	Method and Description
static Mf2FunctionRegistry.Builder	builder() Deprecated. This API is for technology preview only.
String	getDefaultFormatterNameForType(Class<?> clazz) Deprecated. This API is for technology preview only.
Set<Class<?>>	getDefaultFormatterTypes() Deprecated. This API is for technology preview only.
FormatterFactory	getFormatter(String formatterName) Deprecated. This API is for technology preview only.
Set<String>	getFormatterNames() Deprecated. This API is for technology preview only.
SelectorFactory	getSelector(String selectorName) Deprecated. This API is for technology preview only.
Set<String>	getSelectorNames() Deprecated. This API is for technology preview only.

Methods inherited from class java.lang.Object

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

Method Detail

builder

@Deprecated
public static Mf2FunctionRegistry.Builder builder()

Deprecated. This API is for technology preview only.

Creates a builder.

Returns:

the Builder.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

getFormatter

@Deprecated
public FormatterFactory getFormatter(String formatterName)

Deprecated. This API is for technology preview only.

Returns the formatter factory used to create the formatter for function named name.

Note: function name here means the name used to refer to the function in the MessageFormat 2 syntax, for example "... {$exp :datetime} ..."
The function name here is "datetime", and does not have to correspond to the name of the methods / classes used to implement the functionality.

For example one might write a PersonFormatterFactory returning a PersonFormatter, and map that to the MessageFormat function named "person".
The only name visible to the users of MessageFormat syntax will be "person".

Parameters:

formatterName - the function name.

Returns:

the factory creating formatters for name. Returns null if none is registered.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

getFormatterNames

@Deprecated
public Set<String> getFormatterNames()

Deprecated. This API is for technology preview only.

Get all know names that have a mappings from name to FormatterFactory.

Returns:

a set of all the known formatter names.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

getDefaultFormatterNameForType

@Deprecated
public String getDefaultFormatterNameForType(Class<?> clazz)

Deprecated. This API is for technology preview only.

Returns the name of the formatter used to format an object of type clazz.

Parameters:

clazz - the class of the object to format.

Returns:

the name of the formatter class, if registered. Returns null otherwise.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

getDefaultFormatterTypes

@Deprecated
public Set<Class<?>> getDefaultFormatterTypes()

Deprecated. This API is for technology preview only.

Get all know classes that have a mappings from class to function name.

Returns:

a set of all the known classes that have mapping to function names.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

getSelector

@Deprecated
public SelectorFactory getSelector(String selectorName)

Deprecated. This API is for technology preview only.

Returns the selector factory used to create the selector for function named name.

Note: the same comments about naming as the ones on getFormatter apply.

Parameters:

selectorName - the selector name.

Returns:

the factory creating selectors for name. Returns null if none is registered.

See Also:

getFormatter(String)

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

getSelectorNames

@Deprecated
public Set<String> getSelectorNames()

Deprecated. This API is for technology preview only.

Get all know names that have a mappings from name to SelectorFactory.

Returns:

a set of all the known selector names.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.