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

Class ControllerMethodSignatureRule

java.lang.Object

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

All Implemented Interfaces:

Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JMethod,ApiActionMetadata>

public class ControllerMethodSignatureRule
extends Object
implements Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JMethod,ApiActionMetadata>

Generates a method signature for an endpoint defined by an ApiMappingMetadata instance. INPUT: #%RAML 0.8 title: myapi mediaType: application/json baseUri: / /base: /{id} get: OUTPUT: public ResponseType getBaseById(String id) OR: public ResponseType<MyType> getBaseById(@PathVariable String id) OR: public MyType getBaseById(@PathVariable String id) The parameter and return type configuration depends on the underlying paramsRule and responseTypeRule.

Since:

0.4.1

Author:

armin.weisser

Constructor Summary

Constructors

Constructor and Description
ControllerMethodSignatureRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JType,ApiActionMetadata> responseTypeRule, Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata> paramsRule)

Method Summary

Modifier and Type	Method and Description
com.sun.codemodel.JMethod	apply(ApiActionMetadata endpointMetadata, com.sun.codemodel.JDefinedClass generatableType) Add whatever Java source is required to the given generatable to represent this rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

ControllerMethodSignatureRule

public ControllerMethodSignatureRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JType,ApiActionMetadata> responseTypeRule,
                                     Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata> paramsRule)

Method Detail

apply

public com.sun.codemodel.JMethod apply(ApiActionMetadata endpointMetadata,
                                       com.sun.codemodel.JDefinedClass 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<com.sun.codemodel.JDefinedClass,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