com.phoenixnap.oss.ramlapisync.generation.rules.spring

Class SpringControllerInterfaceRule

java.lang.Object

com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule

com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerInterfaceRule

All Implemented Interfaces:

ConfigurableRule<com.sun.codemodel.JCodeModel,com.sun.codemodel.JDefinedClass,ApiResourceMetadata>, Rule<com.sun.codemodel.JCodeModel,com.sun.codemodel.JDefinedClass,ApiResourceMetadata>

Direct Known Subclasses:

Spring3ControllerInterfaceRule, Spring4ControllerInterfaceRule

public abstract class SpringControllerInterfaceRule
extends SpringConfigurableRule

A code generation Rule that provides a standalone Controller interface with Spring4 annotations. The goal is to generate code that does not have to be manually extended by the user. A raml endpoint called /people for example would lead to the following interface only: // 1. Controller Interface @RestController @RequestMapping("/people") interface PeopleController { @RequestMapping(value="", method=RequestMethod.GET) ResponseEntity getPeople(); } Now all the user has to do is to implement a this interface. This way he can implement the endpoint without altering the generated code.

Since:

0.4.1

Author:

armin.weisser, kurt paris

Field Summary

Fields inherited from class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule

ARRAY_PARAMETER_CONFIGURATION, CALLABLE_RESPONSE_CONFIGURATION, PARAMETER_JAVADOC_CONFIGURATION

Constructor Summary

Constructors

Constructor and Description
SpringControllerInterfaceRule()

Method Summary

Modifier and Type	Method and Description
com.sun.codemodel.JDefinedClass	apply(ApiResourceMetadata metadata, com.sun.codemodel.JCodeModel generatableType) Add whatever Java source is required to the given generatable to represent this rule.
protected abstract Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata>	getControllerAnnotationRule()
protected abstract Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata>	getResponseBodyAnnotationRule()

Methods inherited from class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule

applyConfiguration, isAddParameterJavadoc, isAllowArrayParameters, isCallableResponse, setAddParameterJavadoc, setAllowArrayParameters, setCallableResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringControllerInterfaceRule

public SpringControllerInterfaceRule()

Method Detail

apply

public final com.sun.codemodel.JDefinedClass apply(ApiResourceMetadata metadata,
                                                   com.sun.codemodel.JCodeModel generatableType)

Description copied from interface: Rule

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

Parameters:

metadata - 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

getControllerAnnotationRule

protected abstract Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> getControllerAnnotationRule()

getResponseBodyAnnotationRule

protected abstract Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> getResponseBodyAnnotationRule()