com.carma.swagger.doclet.model

Class ApiParameter

java.lang.Object

com.carma.swagger.doclet.model.Property

com.carma.swagger.doclet.model.ApiParameter

public class ApiParameter
extends Property

The ApiParameter represents an API method parameter

Version:

$Id$

Constructor Summary

Constructors

Constructor and Description
ApiParameter(String paramCategory, String name, Boolean required, Boolean allowMultiple, 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 ApiParameter

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllowMultiple() This gets the allowMultiple
String	getName() This gets the name
String	getParamType() This gets the paramType
Boolean	getRequired() This gets the required
int	hashCode()
void	setAllowMultiple(Boolean allowMultiple) This sets the allowMultiple
void	setName(String name) This sets the name
void	setParamType(String paramType) This sets the paramType
void	setRequired(Boolean required) This sets the required
String	toString()

Methods inherited from class com.carma.swagger.doclet.model.Property

getAllowableValues, getDefaultValue, getDescription, getFormat, getItems, getMaximum, getMinimum, getParamCategory, getRawFieldName, getType, getUniqueItems

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiParameter

public ApiParameter(String paramCategory,
            String name,
            Boolean required,
            Boolean allowMultiple,
            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 ApiParameter

Parameters:

name -

paramCategory -

required -

allowMultiple -

type -

format -

description -

itemsRef -

itemsType -

itemsFormat -

uniqueItems -

allowableValues -

minimum -

maximum -

defaultValue -

Method Detail

getParamType

public String getParamType()

This gets the paramType

Returns:

the paramType

setParamType

public void setParamType(String paramType)

This sets the paramType

Parameters:

paramType - the paramType to set

getName

public String getName()

This gets the name

Returns:

the name

setName

public void setName(String name)

This sets the name

Parameters:

name - the name to set

getRequired

public Boolean getRequired()

This gets the required

Returns:

the required

setRequired

public void setRequired(Boolean required)

This sets the required

Parameters:

required - the required to set

getAllowMultiple

public Boolean getAllowMultiple()

This gets the allowMultiple

Returns:

the allowMultiple

setAllowMultiple

public void setAllowMultiple(Boolean allowMultiple)

This sets the allowMultiple

Parameters:

allowMultiple - the allowMultiple to set

hashCode

public int hashCode()

Overrides:

hashCode in class Property

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Property

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Property

See Also:

Object.toString()