com.phoenixnap.oss.ramlapisync.data

Class ApiActionMetadata

java.lang.Object

com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata

public class ApiActionMetadata
extends Object

Class containing the data required to successfully generate code for an api call within a controller

Since:

0.2.1

Author:

Kurt Paris

Constructor Summary

Constructors

Constructor and Description
ApiActionMetadata(ApiResourceMetadata parent, RamlResource resource, RamlActionType actionType, RamlAction action)
ApiActionMetadata(ApiResourceMetadata parent, RamlResource resource, RamlActionType actionType, RamlAction action, String responseContentTypeFilter, boolean injectHttpHeadersParameter)

Method Summary

Modifier and Type	Method and Description
RamlAction	getAction()
RamlActionType	getActionType()
String	getConsumes()
String	getDescription()
boolean	getInjectHttpHeadersParameter()
String	getName()
ApiResourceMetadata	getParent()
Set<ApiParameterMetadata>	getPathVariables()
String	getProduces()
ApiBodyMetadata	getRequestBody()
String	getRequestBodyMime()
Set<ApiParameterMetadata>	getRequestHeaders()
Set<ApiParameterMetadata>	getRequestParameters()
RamlResource	getResource()
Map<String,ApiBodyMetadata>	getResponseBody()
String	getUrl()
void	setAction(RamlAction action)
void	setActionType(RamlActionType actionType)
void	setParent(ApiResourceMetadata parent)
void	setPathVariables(Set<ApiParameterMetadata> pathVariables)
void	setRequestBodyMime(String requestBodyMime)
void	setRequestParameters(Set<ApiParameterMetadata> requestParameters)
void	setResource(RamlResource resource)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiActionMetadata

public ApiActionMetadata(ApiResourceMetadata parent,
                         RamlResource resource,
                         RamlActionType actionType,
                         RamlAction action,
                         String responseContentTypeFilter,
                         boolean injectHttpHeadersParameter)

ApiActionMetadata

public ApiActionMetadata(ApiResourceMetadata parent,
                         RamlResource resource,
                         RamlActionType actionType,
                         RamlAction action)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getPathVariables

public Set<ApiParameterMetadata> getPathVariables()

getRequestParameters

public Set<ApiParameterMetadata> getRequestParameters()

getRequestHeaders

public Set<ApiParameterMetadata> getRequestHeaders()

getUrl

public String getUrl()

getName

public String getName()

getProduces

public String getProduces()

getConsumes

public String getConsumes()

getDescription

public String getDescription()

getParent

public ApiResourceMetadata getParent()

setParent

public void setParent(ApiResourceMetadata parent)

getResource

public RamlResource getResource()

setResource

public void setResource(RamlResource resource)

getActionType

public RamlActionType getActionType()

setActionType

public void setActionType(RamlActionType actionType)

getAction

public RamlAction getAction()

setAction

public void setAction(RamlAction action)

getRequestBody

public ApiBodyMetadata getRequestBody()

setPathVariables

public void setPathVariables(Set<ApiParameterMetadata> pathVariables)

setRequestParameters

public void setRequestParameters(Set<ApiParameterMetadata> requestParameters)

getResponseBody

public Map<String,ApiBodyMetadata> getResponseBody()

getRequestBodyMime

public String getRequestBodyMime()

setRequestBodyMime

public void setRequestBodyMime(String requestBodyMime)

getInjectHttpHeadersParameter

public boolean getInjectHttpHeadersParameter()