Package com.github.thought2code.mcp.annotated.enums

Enum Class JavaTypeToJsonSchemaMapper

java.lang.Object

java.lang.Enum<JavaTypeToJsonSchemaMapper>

com.github.thought2code.mcp.annotated.enums.JavaTypeToJsonSchemaMapper

All Implemented Interfaces:

Serializable, Comparable<JavaTypeToJsonSchemaMapper>, Constable

public enum JavaTypeToJsonSchemaMapper
extends Enum<JavaTypeToJsonSchemaMapper>

This enum is used to map Java types to JSON schema data types.

Author:

codeboyzhou

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOOLEAN	Java boolean is mapped to JSON schema data type boolean.
BOOLEAN_CLASS	Java Boolean is mapped to JSON schema data type boolean.
DOUBLE	Java double is mapped to JSON schema data type number.
DOUBLE_CLASS	Java Double is mapped to JSON schema data type number.
FLOAT	Java float is mapped to JSON schema data type number.
FLOAT_CLASS	Java Float is mapped to JSON schema data type number.
INT	Java int is mapped to JSON schema data type integer.
INTEGER	Java Integer is mapped to JSON schema data type integer.
LONG	Java long is mapped to JSON schema data type number.
LONG_CLASS	Java Long is mapped to JSON schema data type number.
NUMBER	Java Number is mapped to JSON schema data type number.
OBJECT	Java Object is mapped to JSON schema data type object.
STRING	Java String is mapped to JSON schema data type string.

Method Summary

Modifier and Type	Method	Description
String	getJsonSchemaType()	Returns the JSON schema data type.
static String	getJsonSchemaType(Class<?> javaType)	Returns the JSON schema data type for the specified Java class.
static JavaTypeToJsonSchemaMapper	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JavaTypeToJsonSchemaMapper[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STRING

public static final JavaTypeToJsonSchemaMapper STRING

Java String is mapped to JSON schema data type string.

NUMBER

public static final JavaTypeToJsonSchemaMapper NUMBER

Java Number is mapped to JSON schema data type number.

LONG

public static final JavaTypeToJsonSchemaMapper LONG

Java long is mapped to JSON schema data type number.

LONG_CLASS

public static final JavaTypeToJsonSchemaMapper LONG_CLASS

Java Long is mapped to JSON schema data type number.

FLOAT

public static final JavaTypeToJsonSchemaMapper FLOAT

Java float is mapped to JSON schema data type number.

FLOAT_CLASS

public static final JavaTypeToJsonSchemaMapper FLOAT_CLASS

Java Float is mapped to JSON schema data type number.

DOUBLE

public static final JavaTypeToJsonSchemaMapper DOUBLE

Java double is mapped to JSON schema data type number.

DOUBLE_CLASS

public static final JavaTypeToJsonSchemaMapper DOUBLE_CLASS

Java Double is mapped to JSON schema data type number.

INT

public static final JavaTypeToJsonSchemaMapper INT

Java int is mapped to JSON schema data type integer.

INTEGER

public static final JavaTypeToJsonSchemaMapper INTEGER

Java Integer is mapped to JSON schema data type integer.

BOOLEAN

public static final JavaTypeToJsonSchemaMapper BOOLEAN

Java boolean is mapped to JSON schema data type boolean.

BOOLEAN_CLASS

public static final JavaTypeToJsonSchemaMapper BOOLEAN_CLASS

Java Boolean is mapped to JSON schema data type boolean.

OBJECT

public static final JavaTypeToJsonSchemaMapper OBJECT

Java Object is mapped to JSON schema data type object.

Method Details

values

public static JavaTypeToJsonSchemaMapper[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JavaTypeToJsonSchemaMapper valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getJsonSchemaType

public String getJsonSchemaType()

Returns the JSON schema data type.

Returns:

the JSON schema data type

getJsonSchemaType

public static String getJsonSchemaType(Class<?> javaType)

Returns the JSON schema data type for the specified Java class. If the Java class is not supported or mapped to a JSON schema data type, "string" will be returned.

Parameters:

javaType - the Java class

Returns:

the JSON schema data type