com.phoenixnap.oss.ramlapisync.generation.rules

Class GenericJavaClassRule

java.lang.Object

com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule

All Implemented Interfaces:

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

public class GenericJavaClassRule
extends Object
implements Rule<com.sun.codemodel.JCodeModel,com.sun.codemodel.JDefinedClass,ApiResourceMetadata>

This is a configurable template rule which generates a Java artefact (class or interface) based on an ApiControllerMetadata instance. The code generation steps are executed by applying subsequent Rule instances. The caller has to set appropriate Rule instances for each part of the Java class generation. At least a packageRule and a classRule is mandatory. If the ApiControllerMetadata contains one or more endpoints (ApiMappingMetadata) at least methodSignatureRule is mandatory. packageRule - a package declaration rule classCommentRule - an optional class comment rule classAnnotationRules - a set of class annotation rules classRule - a class declaration rule implementsExtendsRule - an optional rule to define implements/extends part of the class declaration fieldDeclerationRules - a set of field declaration rules. May be empty. methodCommentRule - an optional method comment rule methodAnnotationRules - a set of method annotation rules. May be empty. methodSignatureRule - a method signature rule (just the signature, no annotations, no body) metodBodyRule - an optional method body rule

Since:

0.4.1

Author:

armin.weisser

Constructor Summary

Constructors

Constructor and Description
GenericJavaClassRule()

Method Summary

Modifier and Type	Method and Description
GenericJavaClassRule	addClassAnnotationRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> annotationRule)
GenericJavaClassRule	addFieldDeclarationRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JFieldVar,ApiResourceMetadata> fieldDeclerationRule)
GenericJavaClassRule	addMethodAnnotationRule(Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> methodAnnotationRule)
com.sun.codemodel.JDefinedClass	apply(ApiResourceMetadata metadata, com.sun.codemodel.JCodeModel codeModel) Add whatever Java source is required to the given generatable to represent this rule.
GenericJavaClassRule	setClassCommentRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDocComment,ApiResourceMetadata> classCommentRule)
GenericJavaClassRule	setClassRule(Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JDefinedClass,ApiResourceMetadata> classRule)
GenericJavaClassRule	setImplementsExtendsRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass,ApiResourceMetadata> implementsExtendsRule)
GenericJavaClassRule	setMethodBodyRule(Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata> methodBodyRule)
GenericJavaClassRule	setMethodCommentRule(Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JDocComment,ApiActionMetadata> methodCommentRule)
GenericJavaClassRule	setMethodSignatureRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JMethod,ApiActionMetadata> methodSignatureRule)
GenericJavaClassRule	setPackageRule(Rule<com.sun.codemodel.JCodeModel,com.sun.codemodel.JPackage,ApiResourceMetadata> packageRule)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericJavaClassRule

public GenericJavaClassRule()

Method Detail

apply

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

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.JCodeModel,com.sun.codemodel.JDefinedClass,ApiResourceMetadata>

Parameters:

metadata - The meta data from which the code is build.

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

Throws:

IllegalStateException - if a packageRule or classRule is missing or if the ApiControllerMetadata requires a missing methodSignatureRule.

setPackageRule

public GenericJavaClassRule setPackageRule(Rule<com.sun.codemodel.JCodeModel,com.sun.codemodel.JPackage,ApiResourceMetadata> packageRule)

addClassAnnotationRule

public GenericJavaClassRule addClassAnnotationRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> annotationRule)

setClassCommentRule

public GenericJavaClassRule setClassCommentRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDocComment,ApiResourceMetadata> classCommentRule)

setClassRule

public GenericJavaClassRule setClassRule(Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JDefinedClass,ApiResourceMetadata> classRule)

setMethodSignatureRule

public GenericJavaClassRule setMethodSignatureRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JMethod,ApiActionMetadata> methodSignatureRule)

setMethodBodyRule

public GenericJavaClassRule setMethodBodyRule(Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata> methodBodyRule)

addFieldDeclarationRule

public GenericJavaClassRule addFieldDeclarationRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JFieldVar,ApiResourceMetadata> fieldDeclerationRule)

setImplementsExtendsRule

public GenericJavaClassRule setImplementsExtendsRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass,ApiResourceMetadata> implementsExtendsRule)

addMethodAnnotationRule

public GenericJavaClassRule addMethodAnnotationRule(Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> methodAnnotationRule)

setMethodCommentRule

public GenericJavaClassRule setMethodCommentRule(Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JDocComment,ApiActionMetadata> methodCommentRule)