| Package | Description |
|---|---|
| com.phoenixnap.oss.ramlapisync.generation.rules | |
| com.phoenixnap.oss.ramlapisync.generation.rules.basic | |
| com.phoenixnap.oss.ramlapisync.generation.rules.spring |
| Modifier and Type | Interface and Description |
|---|---|
interface |
ConfigurableRule<T,R,M>
An Extension of the rule interface to represent rules that are configurable
|
| Modifier and Type | Class and Description |
|---|---|
class |
GenericJavaClassRule
This is a configurable template rule which generates a Java artefact (class or interface)
based on an ApiControllerMetadata instance.
|
class |
Spring3ControllerDecoratorRule
A code generation Rule that provides a Spring4 Controller based on a decorator pattern.
|
class |
Spring3ControllerInterfaceRule
A code generation Rule that provides a standalone Controller interface with Spring4 annotations.
|
class |
Spring3ControllerStubRule
A code generation Rule that provides a simple Controller stub class with Spring4 annotations and empty method bodies.
|
class |
Spring4ControllerDecoratorRule
A code generation Rule that provides a Spring4 Controller based on a decorator pattern.
|
class |
Spring4ControllerInterfaceRule
A code generation Rule that provides a standalone Controller interface with Spring4 annotations.
|
class |
Spring4ControllerStubRule
A code generation Rule that provides a simple Controller stub class with Spring4 annotations and empty method bodies.
|
class |
Spring4RestTemplateClientRule
Builds a client from a parsed RAML document.
|
class |
SpringFeignClientInterfaceRule
A code generation Rule that provides a standalone
FeignClient. |
| Modifier and Type | Method and Description |
|---|---|
protected Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> |
Spring4ControllerStubRule.getControllerAnnotationRule() |
protected Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> |
Spring4ControllerInterfaceRule.getControllerAnnotationRule() |
protected Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> |
Spring4ControllerDecoratorRule.getControllerAnnotationRule() |
protected Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> |
Spring3ControllerStubRule.getControllerAnnotationRule() |
protected Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> |
Spring3ControllerInterfaceRule.getControllerAnnotationRule() |
protected Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> |
Spring3ControllerDecoratorRule.getControllerAnnotationRule() |
protected Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> |
Spring4ControllerStubRule.getResponseBodyAnnotationRule() |
protected Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> |
Spring4ControllerInterfaceRule.getResponseBodyAnnotationRule() |
protected Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> |
Spring4ControllerDecoratorRule.getResponseBodyAnnotationRule() |
protected Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> |
Spring3ControllerStubRule.getResponseBodyAnnotationRule() |
protected Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> |
Spring3ControllerInterfaceRule.getResponseBodyAnnotationRule() |
protected Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> |
Spring3ControllerDecoratorRule.getResponseBodyAnnotationRule() |
| Modifier and Type | Method and Description |
|---|---|
GenericJavaClassRule |
GenericJavaClassRule.addClassAnnotationRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> annotationRule) |
GenericJavaClassRule |
GenericJavaClassRule.addFieldDeclarationRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JFieldVar,ApiResourceMetadata> fieldDeclerationRule) |
GenericJavaClassRule |
GenericJavaClassRule.addMethodAnnotationRule(Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> methodAnnotationRule) |
GenericJavaClassRule |
GenericJavaClassRule.setClassCommentRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDocComment,ApiResourceMetadata> classCommentRule) |
GenericJavaClassRule |
GenericJavaClassRule.setClassRule(Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JDefinedClass,ApiResourceMetadata> classRule) |
GenericJavaClassRule |
GenericJavaClassRule.setImplementsExtendsRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass,ApiResourceMetadata> implementsExtendsRule) |
GenericJavaClassRule |
GenericJavaClassRule.setMethodBodyRule(Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata> methodBodyRule) |
GenericJavaClassRule |
GenericJavaClassRule.setMethodCommentRule(Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JDocComment,ApiActionMetadata> methodCommentRule) |
GenericJavaClassRule |
GenericJavaClassRule.setMethodSignatureRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JMethod,ApiActionMetadata> methodSignatureRule) |
GenericJavaClassRule |
GenericJavaClassRule.setPackageRule(Rule<com.sun.codemodel.JCodeModel,com.sun.codemodel.JPackage,ApiResourceMetadata> packageRule) |
| Modifier and Type | Class and Description |
|---|---|
class |
ClassAnnotationRule
Adds the specified annotation to the given JDefinedClass
|
class |
ClassCommentRule
Generates a simple class comment.
|
class |
ClassFieldDeclarationRule
Creates a private field declaration for a RestTemplateClass with a Spring @Autowired annotation or a @Value
annotation with a customizable value.
|
class |
ClientInterfaceDeclarationRule
Generates an interface declaration based on the controller name in ApiControllerMetadata.
|
class |
ControllerClassDeclarationRule
Generates an class declaration based on the controller name in ApiControllerMetadata.
|
class |
ControllerInterfaceDeclarationRule
Generates an interface declaration based on the controller name in ApiControllerMetadata.
|
class |
ControllerMethodSignatureRule
Generates a method signature for an endpoint defined by an ApiMappingMetadata instance.
|
class |
DelegatingMethodBodyRule
Generates a method body that delegates the method call to a private field.
|
class |
ImplementMeMethodBodyRule
Generates an empty method body returning null and a TODO comment.
|
class |
ImplementsControllerInterfaceRule
Generates an implements expression based on a given JDefinedClass.
|
class |
MethodCommentRule
A simple method comment.
|
class |
MethodParamsRule
Generates all method parameters needed for an endpoint defined by ApiMappingMetadata.
|
class |
PackageRule
Generates a simple package declaration based on the base package defined in ApiControllerMetadata.
|
class |
ResourceClassDeclarationRule
Generates an class declaration based on the controller name in ApiControllerMetadata.
|
class |
SpringFeignClientInterfaceDeclarationRule
Generates an interface declaration based on the controller name in ApiControllerMetadata.
|
| Constructor and Description |
|---|
ControllerMethodSignatureRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JType,ApiActionMetadata> responseTypeRule,
Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata> paramsRule) |
ControllerMethodSignatureRule(Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JType,ApiActionMetadata> responseTypeRule,
Rule<CodeModelHelper.JExtMethod,com.sun.codemodel.JMethod,ApiActionMetadata> paramsRule) |
| Modifier and Type | Class and Description |
|---|---|
class |
SpringCallableResponseEntityRule
Creates a
Callable as a return type for an endpoint. |
class |
SpringConfigurableRule
Common parent for configurable spring rules
|
class |
SpringControllerDecoratorRule
A code generation Rule that provides a Spring4 Controller based on a decorator pattern.
|
class |
SpringControllerInterfaceRule
A code generation Rule that provides a standalone Controller interface with Spring4 annotations.
|
class |
SpringControllerStubRule
A code generation Rule that provides a simple Controller stub class with Spring4 annotations and empty method bodies.
|
class |
SpringDelegateFieldDeclerationRule
Creates a private field declaration with a Spring @Autowired annotation.
|
class |
SpringFeignClientClassAnnotationRule
Adds a @FeignClient annotation at class level.
|
class |
SpringFeignClientInterfaceDecoratorRule
A code generation Rule that provides a standalone
FeignClient. |
class |
SpringFeignClientResponseTypeRule
Creates a
ResponseEntity as a return type for an endpoint. |
class |
SpringMethodParamsRule
Generates all method parameters with Spring annotations needed for an endpoint defined by ApiMappingMetadata.
|
class |
SpringRequestMappingClassAnnotationRule
Adds a @RequestMapping annotation at class level
The "value" of the @RequestMapping is the controller url from the ApiControllerMetadata instance.
|
class |
SpringRequestMappingMethodAnnotationRule
Adds a @RequestMapping annotation at method level.
|
class |
SpringResponseBodyMethodAnnotationRule
Adds a @ResponseBody annotation to the method if there is response body declared in this endpoints metadata.
|
class |
SpringResponseEntityRule
Creates a org.springframework.http.ResponseEntity as a return type for an endpoint.
|
class |
SpringRestClientMethodBodyRule
Generates a method body that calls the rest template to execute a REST call.
|
class |
SpringRestControllerAnnotationRule
Adds the @Controller or @RestController (depending on Spring Version - 4 by default) annotation to the given JDefinedClass
|
class |
SpringRestTemplateFieldDeclerationRule
Creates a private field declaration with a Spring @Autowired annotation.
|
class |
SpringSimpleCallableResponseTypeRule
Creates a org.springframework.http.ResponseEntity as a return type for an endpoint.
|
class |
SpringSimpleResponseTypeRule
Creates a org.springframework.http.ResponseEntity as a return type for an endpoint.
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> |
SpringControllerStubRule.getControllerAnnotationRule() |
protected abstract Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> |
SpringControllerInterfaceRule.getControllerAnnotationRule() |
protected abstract Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JAnnotationUse,ApiResourceMetadata> |
SpringControllerDecoratorRule.getControllerAnnotationRule() |
protected abstract Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> |
SpringControllerStubRule.getResponseBodyAnnotationRule() |
protected abstract Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> |
SpringControllerInterfaceRule.getResponseBodyAnnotationRule() |
protected abstract Rule<com.sun.codemodel.JMethod,com.sun.codemodel.JAnnotationUse,ApiActionMetadata> |
SpringControllerDecoratorRule.getResponseBodyAnnotationRule() |
Copyright © 2017. All rights reserved.