AbstractProperty (swagger-models 1.6.0 API)

java.lang.Object
- io.swagger.models.properties.AbstractProperty

All Implemented Interfaces:

Property, Cloneable

Direct Known Subclasses:

AbstractNumericProperty, ArrayProperty, BinaryProperty, BooleanProperty, ComposedProperty, DateProperty, DateTimeProperty, FileProperty, MapProperty, ObjectProperty, PasswordProperty, RefProperty, StringProperty, UntypedProperty, UUIDProperty
```
public abstract class AbstractProperty
extends Object
implements Property, Cloneable
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`access`
`protected Boolean`	`allowEmptyValue`
`protected String`	`description`
`protected Object`	`example`
`protected String`	`format`
`protected String`	`name`
`protected Integer`	`position`
`protected Boolean`	`readOnly`
`protected boolean`	`required`
`protected String`	`title`
`protected String`	`type`
`protected Map<String,Object>`	`vendorExtensions`
`protected Xml`	`xml`

Constructor Summary

Constructors
Constructor and Description

AbstractProperty()

Constructors
Constructor and Description
`AbstractProperty()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Property`	`allowEmptyValue(Boolean allowEmptyValue)`
`Property`	`description(String description)`
`boolean`	`equals(Object o)`
`String`	`getAccess()`
`Boolean`	`getAllowEmptyValue()`
`String`	`getDescription()`
`Object`	`getExample()`
`String`	`getFormat()`
`String`	`getName()`
`Integer`	`getPosition()`
`Boolean`	`getReadOnly()`
`boolean`	`getRequired()`
`String`	`getTitle()`
`String`	`getType()`
`Map<String,Object>`	`getVendorExtensions()`
`Xml`	`getXml()`
`int`	`hashCode()`
`Property`	`readOnly()`
`Property`	`rename(String newName)` creates a new instance and renames the property to the given name.
`void`	`setAccess(String access)`
`void`	`setAllowEmptyValue(Boolean allowEmptyValue)`
`void`	`setDefault(String _default)`
`void`	`setDescription(String description)`
`void`	`setExample(Object example)`
`void`	`setExample(String example)`
`void`	`setFormat(String format)`
`void`	`setName(String name)`
`void`	`setPosition(Integer position)`
`void`	`setReadOnly(Boolean readOnly)`
`void`	`setRequired(boolean required)`
`void`	`setTitle(String title)`
`void`	`setType(String type)`
`void`	`setVendorExtension(String name, Object value)`
`void`	`setVendorExtensionMap(Map<String,Object> vendorExtensionMap)`
`void`	`setVendorExtensions(Map<String,Object> vendorExtensions)`
`void`	`setXml(Xml xml)`
`Property`	`title(String title)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

name
```
protected String name
```

type
```
protected String type
```

format
```
protected String format
```

example
```
protected Object example
```

xml
```
protected Xml xml
```

required
```
protected boolean required
```

position
```
protected Integer position
```

description
```
protected String description
```

title
```
protected String title
```

readOnly
```
protected Boolean readOnly
```

allowEmptyValue
```
protected Boolean allowEmptyValue
```

access
```
protected String access
```

vendorExtensions

protected Map<String,Object> vendorExtensions

Constructor Detail
- AbstractProperty
```
public AbstractProperty()
```

Method Detail
- rename
```
public Property rename(String newName)
```
  Description copied from interface: Property
  
  creates a new instance and renames the property to the given name.
  
  Specified by:
  
  rename in interface Property
  
  Returns:
  
  new shallow copy of the property
- title
```
public Property title(String title)
```
  Specified by:
  
  title in interface Property
- description
```
public Property description(String description)
```
  Specified by:
  
  description in interface Property
- readOnly
```
public Property readOnly()
```
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- allowEmptyValue
```
public Property allowEmptyValue(Boolean allowEmptyValue)
```
- getName
```
public String getName()
```
  Specified by:
  
  getName in interface Property
- setName
```
public void setName(String name)
```
  Specified by:
  
  setName in interface Property
- getExample
```
public Object getExample()
```
  Specified by:
  
  getExample in interface Property
- setExample
```
public void setExample(Object example)
```
  Specified by:
  
  setExample in interface Property
- setExample
```
public void setExample(String example)
```
  Specified by:
  
  setExample in interface Property
- getPosition
```
public Integer getPosition()
```
  Specified by:
  
  getPosition in interface Property
- setPosition
```
public void setPosition(Integer position)
```
  Specified by:
  
  setPosition in interface Property
- getType
```
public String getType()
```
  Specified by:
  
  getType in interface Property
- setType
```
public void setType(String type)
```
- getFormat
```
public String getFormat()
```
  Specified by:
  
  getFormat in interface Property
- setFormat
```
public void setFormat(String format)
```
- getXml
```
public Xml getXml()
```
  Specified by:
  
  getXml in interface Property
- setXml
```
public void setXml(Xml xml)
```
  Specified by:
  
  setXml in interface Property
- getRequired
```
public boolean getRequired()
```
  Specified by:
  
  getRequired in interface Property
- setRequired
```
public void setRequired(boolean required)
```
  Specified by:
  
  setRequired in interface Property
- getTitle
```
public String getTitle()
```
  Specified by:
  
  getTitle in interface Property
- setTitle
```
public void setTitle(String title)
```
  Specified by:
  
  setTitle in interface Property
- getDescription
```
public String getDescription()
```
  Specified by:
  
  getDescription in interface Property
- setDescription
```
public void setDescription(String description)
```
  Specified by:
  
  setDescription in interface Property
- getReadOnly
```
public Boolean getReadOnly()
```
  Specified by:
  
  getReadOnly in interface Property
- setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
  Specified by:
  
  setReadOnly in interface Property
- setDefault
```
public void setDefault(String _default)
```
  Specified by:
  
  setDefault in interface Property
- getAccess
```
public String getAccess()
```
  Specified by:
  
  getAccess in interface Property
- setAccess
```
public void setAccess(String access)
```
  Specified by:
  
  setAccess in interface Property
- getAllowEmptyValue
```
public Boolean getAllowEmptyValue()
```
  Specified by:
  
  getAllowEmptyValue in interface Property
- setAllowEmptyValue
```
public void setAllowEmptyValue(Boolean allowEmptyValue)
```
  Specified by:
  
  setAllowEmptyValue in interface Property
- getVendorExtensions
```
public Map<String,Object> getVendorExtensions()
```
  Specified by:
  
  getVendorExtensions in interface Property
- setVendorExtension
```
public void setVendorExtension(String name,
                               Object value)
```
- setVendorExtensions
```
public void setVendorExtensions(Map<String,Object> vendorExtensions)
```
- setVendorExtensionMap
```
public void setVendorExtensionMap(Map<String,Object> vendorExtensionMap)
```

Class AbstractProperty

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

type

format

example

xml

required

position

description

title

readOnly

allowEmptyValue

access

vendorExtensions

Constructor Detail

AbstractProperty

Method Detail

rename

title

description

readOnly

equals

hashCode

allowEmptyValue

getName

setName

getExample

setExample

setExample

getPosition

setPosition

getType

setType

getFormat

setFormat

getXml

setXml

getRequired

setRequired

getTitle

setTitle

getDescription

setDescription

getReadOnly

setReadOnly

setDefault

getAccess

setAccess

getAllowEmptyValue

setAllowEmptyValue

getVendorExtensions

setVendorExtension

setVendorExtensions

setVendorExtensionMap