com.phoenixnap.oss.ramlapisync.data

Class ApiResourceMetadata

java.lang.Object

com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata

public class ApiResourceMetadata
extends Object

Class containing the data required to successfully generate code for an api rest controller within spring mvc

Since:

0.2.1

Author:

Kurt Paris

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTROLLER_SUFFIX

Constructor Summary

Constructors

Constructor and Description
ApiResourceMetadata(String controllerUrl, RamlResource resource, String basePackage, RamlRoot document)

Method Summary

Modifier and Type	Method and Description
void	addApiCall(RamlResource resource, RamlActionType actionType, RamlAction action)
void	addApiCall(RamlResource resource, RamlActionType actionType, RamlAction action, String responseContentType, boolean injectHttpHeadersParameter)
Set<ApiActionMetadata>	getApiCalls()
String	getBasePackage()
String	getControllerUrl()
Set<ApiBodyMetadata>	getDependencies()
String	getDescription()
RamlRoot	getDocument()
String	getName()
RamlResource	getResource()
String	getResourceName()
String	getResourceUri()
void	setSingularizeName(boolean singularizeName)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTROLLER_SUFFIX

public static final String CONTROLLER_SUFFIX

See Also:

Constant Field Values

Constructor Detail

ApiResourceMetadata

public ApiResourceMetadata(String controllerUrl,
                           RamlResource resource,
                           String basePackage,
                           RamlRoot document)

Method Detail

addApiCall

public void addApiCall(RamlResource resource,
                       RamlActionType actionType,
                       RamlAction action)

addApiCall

public void addApiCall(RamlResource resource,
                       RamlActionType actionType,
                       RamlAction action,
                       String responseContentType,
                       boolean injectHttpHeadersParameter)

getApiCalls

public Set<ApiActionMetadata> getApiCalls()

getName

public String getName()

getResource

public RamlResource getResource()

getResourceName

public String getResourceName()

getResourceUri

public String getResourceUri()

getControllerUrl

public String getControllerUrl()

toString

public String toString()

Overrides:

toString in class Object

getBasePackage

public String getBasePackage()

getDependencies

public Set<ApiBodyMetadata> getDependencies()

getDescription

public String getDescription()

getDocument

public RamlRoot getDocument()

setSingularizeName

public void setSingularizeName(boolean singularizeName)