com.phoenixnap.oss.ramlapisync.generation.rules.basic

Class MethodParamsRule

java.lang.Object

com.phoenixnap.oss.ramlapisync.generation.rules.basic.MethodParamsRule

All Implemented Interfaces:

Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata>

Direct Known Subclasses:

SpringMethodParamsRule

public class MethodParamsRule
extends Object
implements Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata>

Generates all method parameters needed for an endpoint defined by ApiMappingMetadata. This includes path variables, request parameters and the request body. INPUT: #%RAML 0.8 title: myapi mediaType: application/json baseUri: / /base: /{id}/elements: get: queryParameters: requiredQueryParam: type: integer required: true optionalQueryParam: type: string optionalQueryParam2: type: number required: false OUTPUT: (String id , Integer requiredQueryParam , String optionalQueryParam , BigDecimal optionalQueryParam2 )

Since:

0.4.1

Author:

armin.weisser, kurt paris

Constructor Summary

Constructors

Constructor and Description
MethodParamsRule()
MethodParamsRule(boolean addParameterJavadoc, boolean allowArrayParameters) If set to true, the rule will also add a parameter javadoc entry

Method Summary

Modifier and Type	Method and Description
com.sun.codemodel.JMethod	apply(ApiActionMetadata endpointMetadata, CodeModelHelper.JExtMethod generatableType) Add whatever Java source is required to the given generatable to represent this rule.
protected com.sun.codemodel.JVar	paramHttpHeaders(CodeModelHelper.JExtMethod generatableType)
protected com.sun.codemodel.JVar	paramObjects(ApiActionMetadata endpointMetadata, CodeModelHelper.JExtMethod generatableType)
protected com.sun.codemodel.JVar	paramQueryForm(ApiParameterMetadata paramMetaData, CodeModelHelper.JExtMethod generatableType)

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodParamsRule

public MethodParamsRule()

MethodParamsRule

public MethodParamsRule(boolean addParameterJavadoc,
                        boolean allowArrayParameters)

If set to true, the rule will also add a parameter javadoc entry

Parameters:

addParameterJavadoc - Set to true for javadocs for parameters

Method Detail

apply

public com.sun.codemodel.JMethod apply(ApiActionMetadata endpointMetadata,
                                       CodeModelHelper.JExtMethod generatableType)

Description copied from interface: Rule

Add whatever Java source is required to the given generatable to represent this rule.

Specified by:

apply in interface Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata>

Parameters:

endpointMetadata - The meta data from which the code is build.

generatableType - A code generation construct to which this rule should be applied

Returns:

The newly generated source code item that was added/created as a result of applying this rule

paramQueryForm

protected com.sun.codemodel.JVar paramQueryForm(ApiParameterMetadata paramMetaData,
                                                CodeModelHelper.JExtMethod generatableType)

paramObjects

protected com.sun.codemodel.JVar paramObjects(ApiActionMetadata endpointMetadata,
                                              CodeModelHelper.JExtMethod generatableType)

paramHttpHeaders

protected com.sun.codemodel.JVar paramHttpHeaders(CodeModelHelper.JExtMethod generatableType)