com.phoenixnap.oss.ramlapisync.generation.rules

Interface Rule<T,R,M>

Type Parameters:

T - The type of the source code item on which this rule can operate. E.g. JClass.

R - The type of the source code item generated by this rule. E.g. JMethod.

M - The type of the meta data that this rule should operate on. E.g ApiControllerMetadata.

All Known Subinterfaces:

ConfigurableRule<T,R,M>

All Known Implementing Classes:

ClassAnnotationRule, ClassCommentRule, ClassFieldDeclarationRule, ClientInterfaceDeclarationRule, ControllerClassDeclarationRule, ControllerInterfaceDeclarationRule, ControllerMethodSignatureRule, DelegatingMethodBodyRule, GenericJavaClassRule, ImplementMeMethodBodyRule, ImplementsControllerInterfaceRule, MethodCommentRule, MethodParamsRule, PackageRule, ResourceClassDeclarationRule, Spring3ControllerDecoratorRule, Spring3ControllerInterfaceRule, Spring3ControllerStubRule, Spring4ControllerDecoratorRule, Spring4ControllerInterfaceRule, Spring4ControllerStubRule, Spring4RestTemplateClientRule, SpringCallableResponseEntityRule, SpringConfigurableRule, SpringControllerDecoratorRule, SpringControllerInterfaceRule, SpringControllerStubRule, SpringDelegateFieldDeclerationRule, SpringFeignClientClassAnnotationRule, SpringFeignClientInterfaceDeclarationRule, SpringFeignClientInterfaceDecoratorRule, SpringFeignClientInterfaceRule, SpringFeignClientResponseTypeRule, SpringMethodParamsRule, SpringRequestMappingClassAnnotationRule, SpringRequestMappingMethodAnnotationRule, SpringResponseBodyMethodAnnotationRule, SpringResponseEntityRule, SpringRestClientMethodBodyRule, SpringRestControllerAnnotationRule, SpringRestTemplateFieldDeclerationRule, SpringSimpleCallableResponseTypeRule, SpringSimpleResponseTypeRule

public interface Rule<T,R,M>

Represents a generic code generation rule (e.g. production of JCodeModel from RAML schema). The Rule can be executed or 'applied' to perform the code generation step.

Since:

0.4.1

Author:

armin.weisser

Method Summary

Modifier and Type	Method and Description
R	apply(M metadata, T generatableType) Add whatever Java source is required to the given generatable to represent this rule.

Method Detail

apply

R apply(M metadata,
        T generatableType)

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