de.fraunhofer.iese.ind2uce.json.schema

Class JsonSchemaGenerator

java.lang.Object

de.fraunhofer.iese.ind2uce.json.schema.JsonSchemaGenerator

public class JsonSchemaGenerator
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	GENERIC_BEGIN
static String	GENERIC_END
static String	MAP_FULL_QUALIFIED_CLASSNAME

Method Summary

Modifier and Type	Method and Description
static List<de.fraunhofer.iese.ind2uce.api.component.description.TypeDescription>	createTypeDescription(Type type, Class typeClass) Generates a list of TypeDescription for a given class.
static de.fraunhofer.iese.ind2uce.api.component.description.JsonType	getJsonType(Class type) Returns a jsonType for a given class.

Methods inherited from class java.lang.Object

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

Field Detail

MAP_FULL_QUALIFIED_CLASSNAME

public static final String MAP_FULL_QUALIFIED_CLASSNAME

See Also:

Constant Field Values

GENERIC_BEGIN

public static final String GENERIC_BEGIN

See Also:

Constant Field Values

GENERIC_END

public static final String GENERIC_END

See Also:

Constant Field Values

Method Detail

createTypeDescription

public static List<de.fraunhofer.iese.ind2uce.api.component.description.TypeDescription> createTypeDescription(Type type,
                                                                                                               Class typeClass)
                                                                                                        throws ClassNotFoundException

Generates a list of TypeDescription for a given class.

• For Primitive Types see JavaReflectionUtils.isInd2ucePrimitive(Class) this Method returns a singleton list with a TypeDescription containing the name of the primitive like java.lang.Long and JsonType.PRIMITIVE
• For Iterable Types (Collections) this Method returns a list with a TypeDescription containing the name of the generic content of the list (e.g. for List<String> name will be java.lang.String) and JsonType.ARRAY. If the generic Type of the list is a non primitive type, this method also adds the description for this type (recursively).
• Array types are handled in the same manner as iterable types.
• Array types are handled in the same manner as iterable types.
• For Maps this Method returns a list with a TypeDescription containing the name Map < SOME_TYPE > and JsonType.OBJECT. If the generic Type (SOME_TYPE) of the map is a non primitive type, this method also adds the description for this type (recursively).

Parameters:

type - Type

typeClass - Class

Returns:

List of TypeDescription

Throws:

ClassNotFoundException - class not found

getJsonType

public static de.fraunhofer.iese.ind2uce.api.component.description.JsonType getJsonType(Class type)

Returns a jsonType for a given class.

• All Primitives including the wrapper types, enums, date and string are mapped to Primitive
• All Iterables and primitive arrays are mapped to JsonType.ARRAY
• The rest is JsonType.OBJECT

Parameters:

type - Class

Returns:

JsonType