ApiModelFieldDocModel (Runtime documentation of REST APIs based on the Spring and JAXB annotations. 1.2 API)

java.lang.Object
- com.apporiented.rest.apidoc.model.ApiModelFieldDocModel

All Implemented Interfaces:: Comparable<ApiModelFieldDocModel>

@ApiModelDoc(value="Model of the documentation of a DTO field.")
public class ApiModelFieldDocModel
extends Object
implements Comparable<ApiModelFieldDocModel>

Model of the documentation of a DTO field.

Author:: Lars Behnke

Constructor Summary

Constructors
Constructor and Description

ApiModelFieldDocModel()

Constructors
Constructor and Description
`ApiModelFieldDocModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ApiModelFieldDocModel o)`
`String[]`	`getAllowedValues()`
`String`	`getDescription()`
`String`	`getFormat()`
`Boolean`	`getMap()`
`String`	`getMapKeyObject()`
`String`	`getMapValueObject()`
`Boolean`	`getMultiple()`
`String`	`getName()`
`String`	`getType()`
`String`	`getXmlNodeType()`
`Boolean`	`isRequired()`
`void`	`setAllowedValues(String[] allowedValues)`
`void`	`setDescription(String description)`
`void`	`setFormat(String format)`
`void`	`setMap(Boolean map)`
`void`	`setMapKeyObject(String mapKeyObject)`
`void`	`setMapValueObject(String mapValueObject)`
`void`	`setMultiple(Boolean multiple)`
`void`	`setName(String name)`
`void`	`setRequired(Boolean required)`
`void`	`setType(String type)`
`void`	`setXmlNodeType(String xmlNodeType)`

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

Constructor Detail
- ApiModelFieldDocModel
```
public ApiModelFieldDocModel()
```

Method Detail

isRequired
```
public Boolean isRequired()
```

setRequired

public void setRequired(Boolean required)

getMapKeyObject
```
public String getMapKeyObject()
```

setMapKeyObject

public void setMapKeyObject(String mapKeyObject)

getMapValueObject
```
public String getMapValueObject()
```

setMapValueObject

public void setMapValueObject(String mapValueObject)

getMap
```
public Boolean getMap()
```

setMap
```
public void setMap(Boolean map)
```

getAllowedValues
```
public String[] getAllowedValues()
```

setAllowedValues

public void setAllowedValues(String[] allowedValues)

getFormat
```
public String getFormat()
```

setFormat
```
public void setFormat(String format)
```

getMultiple
```
public Boolean getMultiple()
```

setMultiple

public void setMultiple(Boolean multiple)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getXmlNodeType
```
public String getXmlNodeType()
```

setXmlNodeType

public void setXmlNodeType(String xmlNodeType)

compareTo
```
public int compareTo(ApiModelFieldDocModel o)
```
Specified by:

compareTo in interface Comparable<ApiModelFieldDocModel>

Class ApiModelFieldDocModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiModelFieldDocModel

Method Detail

isRequired

setRequired

getMapKeyObject

setMapKeyObject

getMapValueObject

setMapValueObject

getMap

setMap

getAllowedValues

setAllowedValues

getFormat

setFormat

getMultiple

setMultiple

getName

setName

getDescription

setDescription

getType

setType

getXmlNodeType

setXmlNodeType

compareTo