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

Class MethodCommentRule

java.lang.Object

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

All Implemented Interfaces:

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

public class MethodCommentRule
extends Object
implements Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JDocComment,ApiActionMetadata>

A simple method comment. If no description is provided by the RAML spec for this enpoint a simple "No description" is added as method comment.

Since:

0.4.1

Author:

armin.weisser

Constructor Summary

Constructors

Constructor and Description
MethodCommentRule()

Method Summary

Modifier and Type	Method and Description
com.sun.codemodel.JDocComment	apply(ApiActionMetadata endpointMetadata, com.sun.codemodel.JMethod 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

MethodCommentRule

public MethodCommentRule()

Method Detail

apply

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