uk.gov.gchq.koryphe.serialisation.json

Class SimpleClassNameCache

java.lang.Object

uk.gov.gchq.koryphe.serialisation.json.SimpleClassNameCache

public final class SimpleClassNameCache
extends Object

A SimpleClassNameCache is a cache for indexing simple class names.

If 2 classes are discovered to have the same simple class name then a useful exception is thrown telling the user to choose which class they want and use the full class name.

This class will scan the class path to resolve the simple class names and cache the results. To allow your class to be included in the resolver you need to annotate it with JsonSimpleClassName or call addSimpleClassNames(boolean, Class[])

In addition to classes annotated with JsonSimpleClassName, implementations of Predicate, Function and BinaryOperator are included. All classes within java.lang and java.util are also included.

By default the full class name will be serialised into json. To override this call setUseFullNameForSerialisation(boolean).

Only a small set of packages on the class path are scanned. You can add extra packages to the scanner. See ReflectionUtil for details.

See Also:

ReflectionUtil

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_USE_FULL_NAME_FOR_SERIALISATION

Method Summary

Modifier and Type	Method and Description
static void	addSimpleClassNames(boolean includeSubtypes, Class... classes) Allows you to add additional classes to the cache that you wish to be accessed via the simple class name.
static String	getClassName(String id) Gets the class name for a given id.
static String	getClassName(String id, com.fasterxml.jackson.databind.JavaType baseType) Gets the class name for a given id.
static String	getSimpleClassName(Class<?> clazz) Gets a simple class name for the given class.
static String	getSimpleClassNameOrNull(Class<?> clazz)
static void	initialise()
static boolean	isUseFullNameForSerialisation()
static void	reset() Resets the caches.
static void	setUseFullNameForSerialisation(boolean useFullNameForSerialisation)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_USE_FULL_NAME_FOR_SERIALISATION

public static final boolean DEFAULT_USE_FULL_NAME_FOR_SERIALISATION

See Also:

Constant Field Values

Method Detail

initialise

public static void initialise()

isUseFullNameForSerialisation

public static boolean isUseFullNameForSerialisation()

Returns:

if true then the full class name is used for serialisation.

setUseFullNameForSerialisation

public static void setUseFullNameForSerialisation(boolean useFullNameForSerialisation)

Parameters:

useFullNameForSerialisation - if true then the full class name is used for serialisation.

addSimpleClassNames

public static void addSimpleClassNames(boolean includeSubtypes,
                                       Class... classes)

Allows you to add additional classes to the cache that you wish to be accessed via the simple class name.

Parameters:

includeSubtypes - if true then all implementations are included.

classes - the classes to be included.

getSimpleClassName

public static String getSimpleClassName(Class<?> clazz)

Gets a simple class name for the given class.

Parameters:

clazz - the class to get the simple class name for.

Returns:

the simple class name, or null a simple class name can't be used.

getSimpleClassNameOrNull

public static String getSimpleClassNameOrNull(Class<?> clazz)

getClassName

public static String getClassName(String id)

Gets the class name for a given id.

Parameters:

id - the simple class name or full class name.

Returns:

the full class name or the original id if one could not be found.

Throws:

IllegalArgumentException - if there are multiple classes with the same id.

getClassName

public static String getClassName(String id,
                                  com.fasterxml.jackson.databind.JavaType baseType)

Gets the class name for a given id.

Parameters:

id - the simple class name or full class name.

baseType - the base type of the ID - used to help resolve conflicting IDs

Returns:

the full class name or the original id if one could not be found.

Throws:

IllegalArgumentException - if there are multiple classes with the same id.

reset

public static void reset()

Resets the caches.