Package ch.tocco.nice2.types.impl

Class TypeManagerImpl

java.lang.Object

ch.tocco.nice2.types.impl.TypeManagerImpl

All Implemented Interfaces:

TypeManager

@Component
public class TypeManagerImpl
extends Object
implements TypeManager

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.types.api.TypeManager

TypeManager.ParseFlags

Constructor Summary

Constructors

Constructor	Description
TypeManagerImpl(org.slf4j.Logger log)

Method Summary

Modifier and Type	Method	Description
<T> T	convert(@Nullable Object o, Type<?> sourceType, Type<T> targetType)
<T> T	convert(@Nullable Object o, Type<T> targetType)	Attempts to convert any object to the desired target type.
void	ensureType(@Nullable String name)	Makes sure the required type exists in the nice system.
@Nullable Type<?>	findBaseType(Class<?> representationClass)	Finds the Type for the given java class for one of its ancestors, if any.
<T> @Nullable Type<T>	getBaseType(Class<T> representationClass)	Returns the Type for the given java class, if any.
Collection<Type<?>>	getBaseTypes()	Returns all available base types (the real ones, without virtual ones).
Type<Boolean>	getBooleanType()
Type<Double>	getDoubleType()
Type<Glob>	getGlobType()
Type<Integer>	getIntegerType()
Type<Long>	getLongType()
Type<Void>	getNullType()
Type<String>	getStringType()
@Nullable Type<?>	getType(String name)	Returns the Type (base or virtual) for the name specified.
Collection<Type<?>>	getTypes()	Returns all available types (including virtual ones).
boolean	hasType(String name)	Tells if such a type or virtual type exists.
Type<?>	matchTypes(Type<?> one, Type<?> two)
TypedValue<?>	parse(String str, TypeManager.ParseFlags... flags)
TypedValue<?>	parse(String typeName, String value, TypeManager.ParseFlags... flags)
TypedValue<?>	parse(String typeName, String value, TypeManager.ParseFlags[] flags, String fullValue)
<T> Type<T>	requireBaseType(Class<T> representationClass)	Same as TypeManager.getBaseType(java.lang.Class<T>) but throws if missing.
Type<?>	requireType(String name)	Same as TypeManager.getType(java.lang.String) but throws if missing.
void	setAdaptersConfig(List<AdapterContribution> contribs)	This is where type adapters from contributions come in.
void	setBaseTypesConfig(List<BaseTypeContribution> contribs)	The contributions are merged in, existing ones are kept.
void	setConversionsConfig(List<ConversionContribution> contribs)	The contributions are merged in, existing ones are kept.
void	setTypeConfig(List<BaseTypeContribution> baseTypes, List<VirtualTypeContribution> virtualTypes, List<ConversionContribution> conversions, List<AdapterContribution> adapters)
void	setVirtualTypesConfig(List<VirtualTypeContribution> contribs)	The contributions are merged in, existing ones are kept.
@Nullable String	suggestType(String name)	Suggests the correct type name when the one looked for does not exist.

Methods inherited from class java.lang.Object

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

Constructor Details

TypeManagerImpl

public TypeManagerImpl(org.slf4j.Logger log)

Method Details

setTypeConfig

@Autowired
public void setTypeConfig(List<BaseTypeContribution> baseTypes,
 List<VirtualTypeContribution> virtualTypes,
 List<ConversionContribution> conversions,
 List<AdapterContribution> adapters)

setBaseTypesConfig

public void setBaseTypesConfig(List<BaseTypeContribution> contribs)

The contributions are merged in, existing ones are kept. Exceptions are thrown on duplicates.

setVirtualTypesConfig

public void setVirtualTypesConfig(List<VirtualTypeContribution> contribs)

The contributions are merged in, existing ones are kept. Exceptions are thrown on duplicates.

setConversionsConfig

public void setConversionsConfig(List<ConversionContribution> contribs)

The contributions are merged in, existing ones are kept. Exceptions are thrown on duplicates.

setAdaptersConfig

public void setAdaptersConfig(List<AdapterContribution> contribs)

This is where type adapters from contributions come in.

The contributions are merged in, existing ones are kept. Exceptions are thrown on duplicates.

Type adapters may implement TypeReceivable (setType()) to receive a reference to their type. For example AbstractTypeAdapter does this.

Parameters:

contribs - The contributions.

getTypes

public Collection<Type<?>> getTypes()

Description copied from interface: TypeManager

Returns all available types (including virtual ones).

Specified by:

getTypes in interface TypeManager

hasType

public boolean hasType(String name)

Description copied from interface: TypeManager

Tells if such a type or virtual type exists.

Specified by:

hasType in interface TypeManager

Parameters:

name - The type's name, eg 'string'.

getType

@Nullable
public @Nullable Type<?> getType(String name)

Description copied from interface: TypeManager

Returns the Type (base or virtual) for the name specified. See https://wiki.tocco.ch/wiki/index.php/Nice2-types

Specified by:

getType in interface TypeManager

Parameters:

name - The type's name, eg 'string'.

Returns:

Null if no such type.

See Also:

• TypeManager.requireType(java.lang.String)
• TypeManager.getBaseType(java.lang.Class<T>)

getBaseTypes

public Collection<Type<?>> getBaseTypes()

Description copied from interface: TypeManager

Returns all available base types (the real ones, without virtual ones).

Specified by:

getBaseTypes in interface TypeManager

getBaseType

@Nullable
public <T> @Nullable Type<T> getBaseType(Class<T> representationClass)

Description copied from interface: TypeManager

Returns the Type for the given java class, if any. For the java to type mappings see https://wiki.tocco.ch/wiki/index.php/Nice2-types

Specified by:

getBaseType in interface TypeManager

Parameters:

representationClass - The class.

Returns:

The type. Null if none. Never a virtual type.

See Also:

• TypeManager.getType(java.lang.String)
• TypeManager.requireBaseType(java.lang.Class<T>)

findBaseType

@Nullable
public @Nullable Type<?> findBaseType(Class<?> representationClass)

Description copied from interface: TypeManager

Finds the Type for the given java class for one of its ancestors, if any. For the java to type mappings see https://wiki.tocco.ch/wiki/index.php/Nice2-types

Specified by:

findBaseType in interface TypeManager

Parameters:

representationClass - The class.

Returns:

The type. Null if none. Never a virtual type.

requireType

public Type<?> requireType(String name)
                    throws NoSuchTypeException

Description copied from interface: TypeManager

Same as TypeManager.getType(java.lang.String) but throws if missing.

Specified by:

requireType in interface TypeManager

Throws:

NoSuchTypeException

See Also:

• TypeManager.getType(java.lang.String)
• TypeManager.requireBaseType(java.lang.Class<T>)

requireBaseType

public <T> Type<T> requireBaseType(Class<T> representationClass)
                            throws NoSuchTypeException

Description copied from interface: TypeManager

Same as TypeManager.getBaseType(java.lang.Class<T>) but throws if missing.

Specified by:

requireBaseType in interface TypeManager

Throws:

NoSuchTypeException

See Also:

• TypeManager.getBaseType(java.lang.Class<T>)
• TypeManager.requireType(java.lang.String)

parse

public TypedValue<?> parse(String str,
 TypeManager.ParseFlags... flags)
                    throws StringConversionException

Specified by:

parse in interface TypeManager

Throws:

StringConversionException

parse

public TypedValue<?> parse(String typeName,
 String value,
 TypeManager.ParseFlags... flags)
                    throws StringConversionException

Specified by:

parse in interface TypeManager

Throws:

StringConversionException

convert

@Nullable
public <T> T convert(@Nullable
 @Nullable Object o,
 Type<T> targetType)
              throws TypeConversionException

Description copied from interface: TypeManager

Attempts to convert any object to the desired target type.

Specified by:

convert in interface TypeManager

Parameters:

o - The object to convert.

Returns:

Object as the converted type, null if input was null (null-in-null-out).

Throws:

TypeConversionException - If there is no such type converter, or the conversion fails.

convert

@Nullable
public <T> T convert(@Nullable
 @Nullable Object o,
 Type<?> sourceType,
 Type<T> targetType)
              throws TypeConversionException

Specified by:

convert in interface TypeManager

Throws:

TypeConversionException

parse

public TypedValue<?> parse(String typeName,
 String value,
 TypeManager.ParseFlags[] flags,
 String fullValue)
                    throws StringConversionException

Throws:

StringConversionException

matchTypes

public Type<?> matchTypes(Type<?> one,
 Type<?> two)

Specified by:

matchTypes in interface TypeManager

getStringType

public Type<String> getStringType()

Specified by:

getStringType in interface TypeManager

getIntegerType

public Type<Integer> getIntegerType()

Specified by:

getIntegerType in interface TypeManager

getLongType

public Type<Long> getLongType()

Specified by:

getLongType in interface TypeManager

getDoubleType

public Type<Double> getDoubleType()

Specified by:

getDoubleType in interface TypeManager

getBooleanType

public Type<Boolean> getBooleanType()

Specified by:

getBooleanType in interface TypeManager

getGlobType

public Type<Glob> getGlobType()

Specified by:

getGlobType in interface TypeManager

getNullType

public Type<Void> getNullType()

Specified by:

getNullType in interface TypeManager

suggestType

@Nullable
public @Nullable String suggestType(String name)

Description copied from interface: TypeManager

Suggests the correct type name when the one looked for does not exist.

Examples are "String" → "string" and "int" → "integer".

If the requested type really exists then the same string is returned, though that's not what this method is meant for.

If the requested type does not look familiar in any way then null is returned.

This method is meant for checking (configuration) input, and telling the implementor quickly what the correct type name is.

Specified by:

suggestType in interface TypeManager

Returns:

The correct type name, or null.

See Also:

• TypeManager.hasType(java.lang.String)
• TypeManager.getType(java.lang.String)

ensureType

public void ensureType(@Nullable
 @Nullable String name)

Description copied from interface: TypeManager

Makes sure the required type exists in the nice system.

If missing then the desired exception is thrown, along with meaningful text info.

This is useful for config readers etc.

Specified by:

ensureType in interface TypeManager

Parameters:

name - The type's name, eg 'string'.