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

Class SpringResponseEntityRule

java.lang.Object

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

All Implemented Interfaces:

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

public class SpringResponseEntityRule
extends Object
implements Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JType,ApiActionMetadata>

Creates a org.springframework.http.ResponseEntity as a return type for an endpoint. If the endpoint declares a response body the first type of the response body will added as a generic type to the ResponseEntity. #%RAML 0.8 title: myapi mediaType: application/json baseUri: / /base: get: /{id}: get: responses: 200: body: application/json: schema: NamedResponseType ... OUTPUT: @ResponseEntity<NamedResponseType>

Since:

0.4.1

Author:

armin.weisser

Constructor Summary

Constructors

Constructor and Description
SpringResponseEntityRule()

Method Summary

Modifier and Type	Method and Description
com.sun.codemodel.JType	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

SpringResponseEntityRule

public SpringResponseEntityRule()

Method Detail

apply

public com.sun.codemodel.JType 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.JType,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