io.swagger.util

Enum PrimitiveType

java.lang.Object

java.lang.Enum<PrimitiveType>

io.swagger.util.PrimitiveType

All Implemented Interfaces:

Serializable, Comparable<PrimitiveType>

public enum PrimitiveType
extends Enum<PrimitiveType>

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

Property Summary

Properties

Type	Property and Description
abstract Property	create

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY Binary
BOOLEAN Boolean.
BYTE Byte.
DATE Date.
DATE_TIME Date and time.
DECIMAL Generic decimal number without specific format.
DOUBLE 64-bit decimal.
FILE Native Java file.
FLOAT 32-bit decimal.
INT 32-bit integer.
INTEGER Generic integer number without specific format.
LONG 64-bit integer.
OBJECT Generic object.
STRING String.
URI URI string.
URL URL string.
UUID UUID string.

Method Summary

Methods

Modifier and Type	Method and Description
abstract Property	createProperty()
static Property	createProperty(String name)
static Property	createProperty(Type type)
static PrimitiveType	fromName(String name)
static PrimitiveType	fromType(Type type)
String	getCommonName()
static String	getCommonName(Type type)
Class<?>	getKeyClass()
static PrimitiveType	valueOf(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

BOOLEAN

public static final PrimitiveType BOOLEAN

Boolean.

STRING

public static final PrimitiveType STRING

String.

BYTE

public static final PrimitiveType BYTE

Byte.

BINARY

public static final PrimitiveType BINARY

Binary

URI

public static final PrimitiveType URI

URI string.

URL

public static final PrimitiveType URL

URL string.

UUID

public static final PrimitiveType UUID

UUID string.

INT

public static final PrimitiveType INT

32-bit integer.

LONG

public static final PrimitiveType LONG

64-bit integer.

FLOAT

public static final PrimitiveType FLOAT

32-bit decimal.

DOUBLE

public static final PrimitiveType DOUBLE

64-bit decimal.

INTEGER

public static final PrimitiveType INTEGER

Generic integer number without specific format.

DECIMAL

public static final PrimitiveType DECIMAL

Generic decimal number without specific format.

DATE

public static final PrimitiveType DATE

Date.

DATE_TIME

public static final PrimitiveType DATE_TIME

Date and time.

FILE

public static final PrimitiveType FILE

Native Java file.

OBJECT

public static final PrimitiveType OBJECT

Generic object.

Property Detail

create

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(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:

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

NullPointerException - if the argument is null

fromType

public static PrimitiveType fromType(Type type)

fromName

public static PrimitiveType fromName(String name)

createProperty

public static Property createProperty(Type type)

createProperty

public static Property createProperty(String name)

getCommonName

public static String getCommonName(Type type)

getKeyClass

public Class<?> getKeyClass()

getCommonName

public String getCommonName()

createProperty

public abstract Property createProperty()