com.carma.swagger.doclet.model

Class Model

java.lang.Object

com.carma.swagger.doclet.model.Model

public class Model
extends Object

The Model represents a description of an input or output entity or sub entity.

Version:

$Id$

Constructor Summary

Constructors

Constructor and Description
Model() This creates a Model
Model(String id, Map<String,Property> properties, List<String> requiredFields, List<String> optionalFields, List<String> subTypes, String discriminator) This creates a Model

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDiscriminator() This gets the discriminator
String	getId() This gets the id
List<String>	getOptionalFields() This gets the optionalFields
Map<String,Property>	getProperties() This gets the properties
List<String>	getRequiredFields() This gets the requiredFields
List<String>	getSubTypes() This gets the subTypes
int	hashCode()
void	setDiscriminator(String discriminator) This sets the discriminator
void	setId(String id) This sets the id
void	setOptionalFields(List<String> optionalFields) This sets the optionalFields
void	setProperties(Map<String,Property> properties) This sets the properties
void	setRequiredFields(List<String> requiredFields) This sets the requiredFields
void	setSubTypes(List<String> subTypes) This sets the subTypes
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Model

public Model()

This creates a Model

Model

public Model(String id,
     Map<String,Property> properties,
     List<String> requiredFields,
     List<String> optionalFields,
     List<String> subTypes,
     String discriminator)

This creates a Model

Parameters:

id -

properties -

requiredFields -

optionalFields -

subTypes -

discriminator -

Method Detail

getId

public String getId()

This gets the id

Returns:

the id

setId

public void setId(String id)

This sets the id

Parameters:

id - the id to set

getProperties

public Map<String,Property> getProperties()

This gets the properties

Returns:

the properties

setProperties

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

This sets the properties

Parameters:

properties - the properties to set

getRequiredFields

public List<String> getRequiredFields()

This gets the requiredFields

Returns:

the requiredFields

setRequiredFields

public void setRequiredFields(List<String> requiredFields)

This sets the requiredFields

Parameters:

requiredFields - the requiredFields to set

getOptionalFields

public List<String> getOptionalFields()

This gets the optionalFields

Returns:

the optionalFields

setOptionalFields

public void setOptionalFields(List<String> optionalFields)

This sets the optionalFields

Parameters:

optionalFields - the optionalFields to set

getSubTypes

public List<String> getSubTypes()

This gets the subTypes

Returns:

the subTypes

setSubTypes

public void setSubTypes(List<String> subTypes)

This sets the subTypes

Parameters:

subTypes - the subTypes to set

getDiscriminator

public String getDiscriminator()

This gets the discriminator

Returns:

the discriminator

setDiscriminator

public void setDiscriminator(String discriminator)

This sets the discriminator

Parameters:

discriminator - the discriminator to set

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()