io.swagger.models.properties

Class ObjectProperty

java.lang.Object

io.swagger.models.properties.AbstractProperty

io.swagger.models.properties.ObjectProperty

All Implemented Interfaces:

Property, Cloneable

public class ObjectProperty
extends AbstractProperty
implements Property

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

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
ObjectProperty()
ObjectProperty(Map<String,Property> properties)

Method Summary

Methods

Modifier and Type	Method and Description
ObjectProperty	_default(String _default)
ObjectProperty	access(String access)
ObjectProperty	description(String description)
ObjectProperty	example(String example)
Map<String,Property>	getProperties()
List<String>	getRequiredProperties()
static boolean	isType(String type)
static boolean	isType(String type, String format)
ObjectProperty	name(String name)
ObjectProperty	properties(Map<String,Property> properties)
ObjectProperty	property(String name, Property property)
ObjectProperty	readOnly()
ObjectProperty	readOnly(boolean readOnly)
ObjectProperty	required(boolean required)
void	setProperties(Map<String,Property> properties)
void	setRequiredProperties(List<String> required)
ObjectProperty	title(String title)
ObjectProperty	vendorExtension(String key, Object obj)
ObjectProperty	xml(Xml xml)

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

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

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

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

ObjectProperty

public ObjectProperty()

ObjectProperty

public ObjectProperty(Map<String,Property> properties)

Method Detail

vendorExtension

public ObjectProperty vendorExtension(String key,
                             Object obj)

isType

public static boolean isType(String type)

isType

public static boolean isType(String type,
             String format)

properties

public ObjectProperty properties(Map<String,Property> properties)

property

public ObjectProperty property(String name,
                      Property property)

access

public ObjectProperty access(String access)

description

public ObjectProperty description(String description)

Specified by:

description in interface Property

Overrides:

description in class AbstractProperty

name

public ObjectProperty name(String name)

title

public ObjectProperty title(String title)

Specified by:

title in interface Property

Overrides:

title in class AbstractProperty

_default

public ObjectProperty _default(String _default)

readOnly

public ObjectProperty readOnly(boolean readOnly)

required

public ObjectProperty required(boolean required)

readOnly

public ObjectProperty readOnly()

Overrides:

readOnly in class AbstractProperty

getProperties

public Map<String,Property> getProperties()

getRequiredProperties

public List<String> getRequiredProperties()

setRequiredProperties

public void setRequiredProperties(List<String> required)

setProperties

public void setProperties(Map<String,Property> properties)

xml

public ObjectProperty xml(Xml xml)

example

public ObjectProperty example(String example)