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

Class ClientInterfaceDeclarationRule

java.lang.Object

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

All Implemented Interfaces:

Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JDefinedClass,ApiResourceMetadata>

public class ClientInterfaceDeclarationRule
extends Object
implements Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JDefinedClass,ApiResourceMetadata>

Generates an interface declaration based on the controller name in ApiControllerMetadata. INPUT: #%RAML 0.8 title: myapi mediaType: application/json baseUri: / /base: OUTPUT: public interface BaseClient { }

Since:

0.5.0

Author:

kurtpa

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_SUFFIX

Constructor Summary

Constructors

Constructor and Description
ClientInterfaceDeclarationRule()

Method Summary

Modifier and Type	Method and Description
com.sun.codemodel.JDefinedClass	apply(ApiResourceMetadata controllerMetadata, com.sun.codemodel.JPackage 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

Field Detail

CLIENT_SUFFIX

public static final String CLIENT_SUFFIX

See Also:

Constant Field Values

Constructor Detail

ClientInterfaceDeclarationRule

public ClientInterfaceDeclarationRule()

Method Detail

apply

public com.sun.codemodel.JDefinedClass apply(ApiResourceMetadata controllerMetadata,
                                             com.sun.codemodel.JPackage 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.JPackage,com.sun.codemodel.JDefinedClass,ApiResourceMetadata>

Parameters:

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