com.carma.swagger.doclet.model

Class Property

java.lang.Object

com.carma.swagger.doclet.model.Property

Direct Known Subclasses:

ApiParameter

public class Property
extends Object

The Property represents a model property

Version:

$Id$

Constructor Summary

Constructors

Constructor and Description
Property(String rawFieldName, String paramCategory, String type, String format, String description, String itemsRef, String itemsType, String itemsFormat, Boolean uniqueItems, List<String> allowableValues, String minimum, String maximum, String defaultValue) This creates a Property

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getAllowableValues() This gets the allowableValues
String	getDefaultValue() This gets the defaultValue
String	getDescription() This gets the description of the property
String	getFormat() This gets the format
PropertyItems	getItems() This gets the items in the collection
String	getMaximum() This gets the maximum value of the property
String	getMinimum() This gets the minimum value of the property
String	getParamCategory() This gets category of parameter of the field, only applicable to composite parameter fields
String	getRawFieldName() This gets the raw field name the property came from
String	getType() This gets the type of property
Boolean	getUniqueItems() This gets the uniqueItems
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property(String rawFieldName,
        String paramCategory,
        String type,
        String format,
        String description,
        String itemsRef,
        String itemsType,
        String itemsFormat,
        Boolean uniqueItems,
        List<String> allowableValues,
        String minimum,
        String maximum,
        String defaultValue)

This creates a Property

Parameters:

rawFieldName -

paramCategory -

type -

format -

description -

itemsRef -

itemsType -

itemsFormat -

uniqueItems -

allowableValues -

minimum -

maximum -

defaultValue -

Method Detail

getRawFieldName

public String getRawFieldName()

This gets the raw field name the property came from

Returns:

the raw field name the property came from

getParamCategory

public String getParamCategory()

This gets category of parameter of the field, only applicable to composite parameter fields

Returns:

the category of parameter of the field, only applicable to composite parameter fields

getType

public String getType()

This gets the type of property

Returns:

the type of property

getFormat

public String getFormat()

This gets the format

Returns:

the format

getDescription

public String getDescription()

This gets the description of the property

Returns:

the description of the property

getAllowableValues

public List<String> getAllowableValues()

This gets the allowableValues

Returns:

the allowableValues

getUniqueItems

public Boolean getUniqueItems()

This gets the uniqueItems

Returns:

the uniqueItems

getItems

public PropertyItems getItems()

This gets the items in the collection

Returns:

The items in the collection

getMinimum

public String getMinimum()

This gets the minimum value of the property

Returns:

the minimum value of the property

getMaximum

public String getMaximum()

This gets the maximum value of the property

Returns:

the maximum value of the property

getDefaultValue

public String getDefaultValue()

This gets the defaultValue

Returns:

the defaultValue

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()