Package ch.tocco.nice2.types.api

Interface TypeManager

All Known Implementing Classes:

TypeManagerImpl

public interface TypeManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TypeManager.ParseFlags

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 type, String value, TypeManager.ParseFlags... flags)
<T> Type<T>	requireBaseType(Class<T> representationClass)	Same as getBaseType(java.lang.Class<T>) but throws if missing.
Type<?>	requireType(String name)	Same as getType(java.lang.String) but throws if missing.
@Nullable String	suggestType(String name)	Suggests the correct type name when the one looked for does not exist.

Method Details

getTypes

Collection<Type<?>> getTypes()

Returns all available types (including virtual ones).

hasType

boolean hasType(String name)

Tells if such a type or virtual type exists.

Parameters:

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

getType

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

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

Parameters:

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

Returns:

Null if no such type.

See Also:

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

getBaseTypes

Collection<Type<?>> getBaseTypes()

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

getBaseType

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

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

Parameters:

representationClass - The class.

Returns:

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

See Also:

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

findBaseType

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

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

Parameters:

representationClass - The class.

Returns:

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

requireType

Type<?> requireType(String name)
             throws NoSuchTypeException

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

Throws:

NoSuchTypeException

See Also:

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

requireBaseType

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

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

Throws:

NoSuchTypeException

See Also:

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

parse

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

Throws:

StringConversionException

parse

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

Throws:

StringConversionException

convert

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

Attempts to convert any object to the desired target type.

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

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

Throws:

TypeConversionException

matchTypes

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

getStringType

Type<String> getStringType()

getIntegerType

Type<Integer> getIntegerType()

getLongType

Type<Long> getLongType()

getDoubleType

Type<Double> getDoubleType()

getBooleanType

Type<Boolean> getBooleanType()

getGlobType

Type<Glob> getGlobType()

getNullType

Type<Void> getNullType()

suggestType

@Nullable
@Nullable String suggestType(String name)

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.

Returns:

The correct type name, or null.

See Also:

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

ensureType

void ensureType(@Nullable
 @Nullable String name)
         throws IllegalArgumentException

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.

Parameters:

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

Throws:

IllegalArgumentException