com.carma.swagger.doclet.model

Class ApiDeclaration

java.lang.Object

com.carma.swagger.doclet.model.ApiDeclaration

public class ApiDeclaration
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiDeclaration(String swaggerVersion, String apiVersion, String basePath, String resourcePath, List<Api> apis, Map<String,Model> models, int priority, String description)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<Api>	getApis() This gets the apis
String	getApiVersion()
String	getBasePath()
String	getDescription() This gets the description of this api declaration in a resource listing
Map<String,Model>	getModels() This gets the models
int	getPriority() This gets the priority of this api declaration in a resource listing
String	getResourcePath()
String	getSwaggerVersion()
int	hashCode()
void	setApis(List<Api> apis) This sets the apis
void	setDescription(String description) This sets the description
void	setModels(Map<String,Model> models) This sets the models
void	setPriority(int priority) This sets the priority
void	setResourcePath(String resourcePath) This sets the resourcePath
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDeclaration

public ApiDeclaration(String swaggerVersion,
              String apiVersion,
              String basePath,
              String resourcePath,
              List<Api> apis,
              Map<String,Model> models,
              int priority,
              String description)

Method Detail

getApiVersion

public String getApiVersion()

getSwaggerVersion

public String getSwaggerVersion()

getBasePath

public String getBasePath()

getResourcePath

public String getResourcePath()

setResourcePath

public void setResourcePath(String resourcePath)

This sets the resourcePath

Parameters:

resourcePath - the resourcePath to set

getApis

public List<Api> getApis()

This gets the apis

Returns:

the apis

setApis

public void setApis(List<Api> apis)

This sets the apis

Parameters:

apis - the apis to set

getModels

public Map<String,Model> getModels()

This gets the models

Returns:

the models

setModels

public void setModels(Map<String,Model> models)

This sets the models

Parameters:

models - the models to set

getPriority

public int getPriority()

This gets the priority of this api declaration in a resource listing

Returns:

the priority

getDescription

public String getDescription()

This gets the description of this api declaration in a resource listing

Returns:

the description

setPriority

public void setPriority(int priority)

This sets the priority

Parameters:

priority - the priority to set

setDescription

public void setDescription(String description)

This sets the description

Parameters:

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