io.swagger.models.properties

Class DecimalProperty

java.lang.Object

io.swagger.models.properties.AbstractProperty

io.swagger.models.properties.AbstractNumericProperty

io.swagger.models.properties.DecimalProperty

All Implemented Interfaces:

Property, Cloneable

Direct Known Subclasses:

DoubleProperty, FloatProperty

public class DecimalProperty
extends AbstractNumericProperty

The DecimalProperty class defines properties for (decimal) numbers without a specific format, or with a custom format. The two standard formats are defined in DoubleProperty and FloatProperty.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Fields inherited from class io.swagger.models.properties.AbstractNumericProperty

exclusiveMaximum, exclusiveMinimum, maximum, minimum, multipleOf

Fields inherited from class io.swagger.models.properties.AbstractProperty

access, allowEmptyValue, description, example, format, name, position, readOnly, required, title, type, vendorExtensions, xml

Constructor Summary

Constructors

Constructor and Description
DecimalProperty()
DecimalProperty(String format)

Method Summary

Modifier and Type	Method and Description
DecimalProperty	example(String example)
static boolean	isType(String type, String format)
DecimalProperty	readOnly()
void	setExample(Object example)
DecimalProperty	vendorExtension(String key, Object obj)
DecimalProperty	xml(Xml xml)

Methods inherited from class io.swagger.models.properties.AbstractNumericProperty

equals, exclusiveMaximum, exclusiveMinimum, getExclusiveMaximum, getExclusiveMinimum, getMaximum, getMinimum, getMultipleOf, hashCode, maximum, minimum, multipleOf, setExclusiveMaximum, setExclusiveMinimum, setMaximum, setMinimum, setMultipleOf

Methods inherited from class io.swagger.models.properties.AbstractProperty

allowEmptyValue, description, getAccess, getAllowEmptyValue, getDescription, getExample, getFormat, getName, getPosition, getReadOnly, getRequired, getTitle, getType, getVendorExtensions, getXml, rename, setAccess, setAllowEmptyValue, setDefault, setDescription, setExample, setFormat, setName, setPosition, setReadOnly, setRequired, setTitle, setType, setVendorExtension, setVendorExtensionMap, setVendorExtensions, setXml, title

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.models.properties.Property

description, getAccess, getAllowEmptyValue, getDescription, getExample, getFormat, getName, getPosition, getReadOnly, getRequired, getTitle, getType, getVendorExtensions, getXml, rename, setAccess, setAllowEmptyValue, setDefault, setDescription, setExample, setName, setPosition, setReadOnly, setRequired, setTitle, setXml, title

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

DecimalProperty

public DecimalProperty()

DecimalProperty

public DecimalProperty(String format)

Method Detail

isType

public static boolean isType(String type,
                             String format)

xml

public DecimalProperty xml(Xml xml)

example

public DecimalProperty example(String example)

vendorExtension

public DecimalProperty vendorExtension(String key,
                                       Object obj)

readOnly

public DecimalProperty readOnly()

Overrides:

readOnly in class AbstractProperty

setExample

public void setExample(Object example)

Specified by:

setExample in interface Property

Overrides:

setExample in class AbstractProperty