io.micronaut.openapi.swagger

Enum PrimitiveType

java.lang.Object

java.lang.Enum<PrimitiveType>

io.micronaut.openapi.swagger.PrimitiveType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PrimitiveType>

@Internal
public enum PrimitiveType
extends java.lang.Enum<PrimitiveType>

The PrimitiveType enumeration defines a mapping of limited set of classes into Swagger primitive types.

This class is copied from swagger-core library.

Since:

4.6.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY
BOOLEAN
BYTE
DATE
DATE_TIME
DECIMAL
DOUBLE
EMAIL
FILE
FLOAT
INT
INTEGER
LONG
NUMBER
OBJECT
PARTIAL_TIME
STRING
URI
URL
UUID

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,java.lang.String>	datatypeMappings

Method Summary

Modifier and Type	Method and Description
abstract io.swagger.v3.oas.models.media.Schema	createProperty()
static io.swagger.v3.oas.models.media.Schema	createProperty(java.lang.String name)
static io.swagger.v3.oas.models.media.Schema	createProperty(java.lang.reflect.Type type)
static java.util.Map<java.lang.String,PrimitiveType>	customClasses() Adds support for custom mapping of classes to primitive types
static java.util.Set<java.lang.String>	customExcludedClasses() Adds support for custom mapping of classes to primitive types
static java.util.Set<java.lang.String>	customExcludedExternalClasses() Adds support for custom mapping of classes to primitive types
static void	enablePartialTime() Convenience method to map LocalTime to string primitive with rfc3339 format partial-time.
static PrimitiveType	fromName(java.lang.String name)
static PrimitiveType	fromType(java.lang.reflect.Type type)
static PrimitiveType	fromTypeAndFormat(java.lang.String type, java.lang.String format)
java.lang.String	getCommonName()
static java.lang.String	getCommonName(java.lang.reflect.Type type)
java.lang.Class<?>	getKeyClass()
static java.util.Set<java.lang.String>	nonSystemTypePackages() package names NOT to be considered as "system" types
static java.util.Set<java.lang.String>	nonSystemTypes() class qualified names NOT to be considered as "system" types
static java.util.Set<java.lang.String>	systemPrefixes() class qualified names prefixes to be considered as "system" types
static PrimitiveType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PrimitiveType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STRING

public static final PrimitiveType STRING

BOOLEAN

public static final PrimitiveType BOOLEAN

BYTE

public static final PrimitiveType BYTE

BINARY

public static final PrimitiveType BINARY

URI

public static final PrimitiveType URI

URL

public static final PrimitiveType URL

EMAIL

public static final PrimitiveType EMAIL

UUID

public static final PrimitiveType UUID

INT

public static final PrimitiveType INT

LONG

public static final PrimitiveType LONG

FLOAT

public static final PrimitiveType FLOAT

DOUBLE

public static final PrimitiveType DOUBLE

INTEGER

public static final PrimitiveType INTEGER

DECIMAL

public static final PrimitiveType DECIMAL

NUMBER

public static final PrimitiveType NUMBER

DATE

public static final PrimitiveType DATE

DATE_TIME

public static final PrimitiveType DATE_TIME

PARTIAL_TIME

public static final PrimitiveType PARTIAL_TIME

FILE

public static final PrimitiveType FILE

OBJECT

public static final PrimitiveType OBJECT

Field Detail

datatypeMappings

public static final java.util.Map<java.lang.String,java.lang.String> datatypeMappings

Method Detail

values

public static PrimitiveType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PrimitiveType c : PrimitiveType.values())
    System.out.println(c);

Returns:

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

valueOf

public static PrimitiveType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

customExcludedClasses

public static java.util.Set<java.lang.String> customExcludedClasses()

Adds support for custom mapping of classes to primitive types

Returns:

Map of custom classes to primitive type

Since:

2.0.6

customExcludedExternalClasses

public static java.util.Set<java.lang.String> customExcludedExternalClasses()

Adds support for custom mapping of classes to primitive types

Returns:

Map of custom classes to primitive type

Since:

2.1.2

customClasses

public static java.util.Map<java.lang.String,PrimitiveType> customClasses()

Adds support for custom mapping of classes to primitive types

Returns:

Map of custom classes to primitive type

Since:

2.0.6

systemPrefixes

public static java.util.Set<java.lang.String> systemPrefixes()

class qualified names prefixes to be considered as "system" types

Returns:

Mutable set of class qualified names prefixes to be considered as "system" types

Since:

2.0.6

nonSystemTypes

public static java.util.Set<java.lang.String> nonSystemTypes()

class qualified names NOT to be considered as "system" types

Returns:

Mutable set of class qualified names NOT to be considered as "system" types

Since:

2.0.6

nonSystemTypePackages

public static java.util.Set<java.lang.String> nonSystemTypePackages()

package names NOT to be considered as "system" types

Returns:

Mutable set of package names NOT to be considered as "system" types

Since:

2.0.6

fromType

public static PrimitiveType fromType(java.lang.reflect.Type type)

fromName

public static PrimitiveType fromName(java.lang.String name)

fromTypeAndFormat

public static PrimitiveType fromTypeAndFormat(java.lang.String type,
                                              java.lang.String format)

createProperty

public static io.swagger.v3.oas.models.media.Schema createProperty(java.lang.reflect.Type type)

createProperty

public static io.swagger.v3.oas.models.media.Schema createProperty(java.lang.String name)

getCommonName

public static java.lang.String getCommonName(java.lang.reflect.Type type)

getKeyClass

public java.lang.Class<?> getKeyClass()

getCommonName

public java.lang.String getCommonName()

createProperty

public abstract io.swagger.v3.oas.models.media.Schema createProperty()

enablePartialTime

public static void enablePartialTime()

Convenience method to map LocalTime to string primitive with rfc3339 format partial-time. See link

Since:

2.0.6