io.jmix.core.metamodel.datatype

Interface DatatypeRegistry

All Known Implementing Classes:

DatatypeRegistryImpl

public interface DatatypeRegistry

Registry for Datatypes

Method Summary

Modifier and Type	Method and Description
<T> Datatype<T>	find(java.lang.Class<T> javaClass) Get Datatype instance by the corresponding Java class.
Datatype<?>	find(java.lang.String id) Get Datatype instance by id.
<T> Datatype<T>	get(java.lang.Class<T> javaClass) Get Datatype instance by the corresponding Java class.
Datatype<?>	get(java.lang.String id) Get Datatype instance by its unique id
java.lang.String	getId(Datatype<?> datatype) Returns an ID of the given datatype in the registry.
java.lang.String	getIdByJavaClass(java.lang.Class<?> javaClass) Returns an ID of a first datatype handling the given Java class.
java.util.Optional<java.lang.String>	getIdByJavaClassOptional(java.lang.Class<?> javaClass)
java.util.Optional<java.lang.String>	getIdOptional(Datatype<?> datatype)
java.util.Set<java.lang.String>	getIds()
void	register(Datatype<?> datatype, java.lang.String id, boolean defaultForJavaClass) Register a datatype instance

Method Detail

get

Datatype<?> get(java.lang.String id)

Get Datatype instance by its unique id

Returns:

Datatype instance

Throws:

java.lang.IllegalArgumentException - if no datatype with the given name found

find

@Nullable
Datatype<?> find(java.lang.String id)

Get Datatype instance by id.

Returns:

Datatype instance or null if not found

find

@Nullable
<T> Datatype<T> find(java.lang.Class<T> javaClass)

Get Datatype instance by the corresponding Java class. This method tries to find matching supertype too.

Returns:

Datatype instance or null if not found

get

<T> Datatype<T> get(java.lang.Class<T> javaClass)

Get Datatype instance by the corresponding Java class. This method tries to find matching supertype too.

Returns:

Datatype instance

Throws:

java.lang.IllegalArgumentException - if no datatype suitable for the given type found

getId

java.lang.String getId(Datatype<?> datatype)

Returns an ID of the given datatype in the registry.

Throws:

java.lang.IllegalArgumentException - if the datatype is not registered

getIdOptional

java.util.Optional<java.lang.String> getIdOptional(Datatype<?> datatype)

Returns:

the ID of the given datatype wrapped in Optional if it found in the registry, otherwise an empty Optional.

getIdByJavaClass

java.lang.String getIdByJavaClass(java.lang.Class<?> javaClass)

Returns an ID of a first datatype handling the given Java class.

Throws:

java.lang.IllegalArgumentException - if no datatypes handle the given Java class

getIdByJavaClassOptional

java.util.Optional<java.lang.String> getIdByJavaClassOptional(java.lang.Class<?> javaClass)

Returns:

the ID of a first datatype handling the given Java class wrapped in Optional if it found, otherwise an empty Optional.

getIds

java.util.Set<java.lang.String> getIds()

Returns:

all registered datatype identifiers.

register

void register(Datatype<?> datatype,
              java.lang.String id,
              boolean defaultForJavaClass)

Register a datatype instance

Parameters:

datatype - datatype instance

id - unique registration id

defaultForJavaClass - true if the datatype should be default for a Java class handled by this datatype