- ACTION_MISSING - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionExistenceChecker
-
- ActionContentTypeChecker - Class in com.phoenixnap.oss.ramlapisync.verification.checkers
-
A checker that will check request and response media types.
- ActionContentTypeChecker() - Constructor for class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionContentTypeChecker
-
- ActionExistenceChecker - Class in com.phoenixnap.oss.ramlapisync.verification.checkers
-
A visitor that will be invoked when an action is identified
- ActionExistenceChecker() - Constructor for class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionExistenceChecker
-
- ActionQueryParameterChecker - Class in com.phoenixnap.oss.ramlapisync.verification.checkers
-
A visitor that will be invoked when an action is identified
- ActionQueryParameterChecker() - Constructor for class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionQueryParameterChecker
-
- ActionResponseBodySchemaChecker - Class in com.phoenixnap.oss.ramlapisync.verification.checkers
-
A checker that will check the response body declared in an API and the supplied implementation
- ActionResponseBodySchemaChecker() - Constructor for class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionResponseBodySchemaChecker
-
- ActionSecurityResponseChecker - Class in com.phoenixnap.oss.ramlapisync.style.checkers
-
Action style checker that enforces that 401 and 403 responses are defined when a security scheme is defined for an API
- ActionSecurityResponseChecker() - Constructor for class com.phoenixnap.oss.ramlapisync.style.checkers.ActionSecurityResponseChecker
-
- addAction(RamlActionType, RamlAction) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- addAction(RamlActionType, RamlAction) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- addActions(Map<RamlActionType, RamlAction>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- addActions(Map<RamlActionType, RamlAction>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- addApiCall(RamlResource, RamlActionType, RamlAction) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- addApiCall(RamlResource, RamlActionType, RamlAction, String, boolean) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- addClassAnnotationRule(Rule<JDefinedClass, JAnnotationUse, ApiResourceMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- addFieldDeclarationRule(Rule<JDefinedClass, JFieldVar, ApiResourceMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- addFormParameters(String, List<RamlFormParameter>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlMimeType
-
- addFormParameters(String, List<RamlFormParameter>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlMimeType
-
- addHeadersForMethod(RamlAction, RamlActionType, Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Allows children to add common headers to API methods (eg CSRF, Authorization)
- addHeadersForMethod(RamlAction, RamlActionType, Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- addIssue(IssueLocation, String, String) - Method in class com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckVisitorCoordinator
-
- addIssue(Set<Issue>, Set<Issue>, Issue, String) - Static method in class com.phoenixnap.oss.ramlapisync.verification.checkers.RamlCheckerResourceVisitorCoordinator
-
Adds an issue to the respective set according to issue severity and logs at the appropriate log level
- addMethodAnnotationRule(Rule<JMethod, JAnnotationUse, ApiActionMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- addQueryParameters(Map<String, RamlQueryParameter>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- addQueryParameters(Map<String, RamlQueryParameter>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- addResource(String, RamlResource) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResourceRoot
-
- addResource(String, RamlResource) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- addResource(String, RamlResource) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- addResources(Map<String, RamlResource>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResourceRoot
-
- addResources(Map<String, RamlResource>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- addResources(Map<String, RamlResource>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- addResponse(String, RamlResponse) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- addResponse(String, RamlResponse) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- addToBody(String, RamlMimeType) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResponse
-
- addToBody(String, RamlMimeType) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResponse
-
- addUriParameter(String, RamlUriParameter) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- addUriParameter(String, RamlUriParameter) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- ApiActionMetadata - Class in com.phoenixnap.oss.ramlapisync.data
-
Class containing the data required to successfully generate code for an api call within a controller
- ApiActionMetadata(ApiResourceMetadata, RamlResource, RamlActionType, RamlAction, String, boolean) - Constructor for class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- ApiActionMetadata(ApiResourceMetadata, RamlResource, RamlActionType, RamlAction) - Constructor for class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- ApiBodyMetadata - Class in com.phoenixnap.oss.ramlapisync.data
-
Class containing the data required to successfully generate code for an api request or response body
- ApiBodyMetadata(String, String, JCodeModel) - Constructor for class com.phoenixnap.oss.ramlapisync.data.ApiBodyMetadata
-
- ApiDocumentMetadata - Class in com.phoenixnap.oss.ramlapisync.data
-
Class containing information about a document to be included in the generated raml file.
- ApiDocumentMetadata(ClassPath.ResourceInfo, String) - Constructor for class com.phoenixnap.oss.ramlapisync.data.ApiDocumentMetadata
-
- ApiParameterMetadata - Class in com.phoenixnap.oss.ramlapisync.data
-
Data object containing information kept at runtime for Api Call Parameters.
- ApiParameterMetadata(String, RamlAbstractParam) - Constructor for class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
Default constructor that creates a metadata object from a Raml parameter
- ApiParameterMetadata(Parameter) - Constructor for class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
Default constructor that creates a metadata object from a Java parameter
- ApiResourceMetadata - Class in com.phoenixnap.oss.ramlapisync.data
-
Class containing the data required to successfully generate code for an api rest controller within spring mvc
- ApiResourceMetadata(String, RamlResource, String, RamlRoot) - Constructor for class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- apply(ApiResourceMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassAnnotationRule
-
- apply(ApiResourceMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassCommentRule
-
- apply(ApiResourceMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassFieldDeclarationRule
-
- apply(ApiResourceMetadata, JPackage) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClientInterfaceDeclarationRule
-
- apply(ApiResourceMetadata, JPackage) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ControllerInterfaceDeclarationRule
-
- apply(ApiActionMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ControllerMethodSignatureRule
-
- apply(ApiActionMetadata, CodeModelHelper.JExtMethod) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.DelegatingMethodBodyRule
-
- apply(ApiActionMetadata, CodeModelHelper.JExtMethod) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ImplementMeMethodBodyRule
-
- apply(ApiResourceMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ImplementsControllerInterfaceRule
-
- apply(ApiActionMetadata, JMethod) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.MethodCommentRule
-
- apply(ApiActionMetadata, CodeModelHelper.JExtMethod) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.MethodParamsRule
-
- apply(ApiResourceMetadata, JCodeModel) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.PackageRule
-
- apply(ApiResourceMetadata, JPackage) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ResourceClassDeclarationRule
-
- apply(ApiResourceMetadata, JPackage) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.SpringFeignClientInterfaceDeclarationRule
-
- apply(ApiResourceMetadata, JCodeModel) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- apply(M, T) - Method in interface com.phoenixnap.oss.ramlapisync.generation.rules.Rule
-
Add whatever Java source is required to the given generatable to
represent this rule.
- apply(ApiActionMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringCallableResponseEntityRule
-
- apply(ApiResourceMetadata, JCodeModel) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerDecoratorRule
-
- apply(ApiResourceMetadata, JCodeModel) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerInterfaceRule
-
- apply(ApiResourceMetadata, JCodeModel) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerStubRule
-
- apply(ApiResourceMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringDelegateFieldDeclerationRule
-
- apply(ApiResourceMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringFeignClientClassAnnotationRule
-
- apply(ApiResourceMetadata, JCodeModel) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringFeignClientInterfaceDecoratorRule
-
- apply(ApiActionMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringFeignClientResponseTypeRule
-
- apply(ApiResourceMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRequestMappingClassAnnotationRule
-
- apply(ApiActionMetadata, JMethod) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRequestMappingMethodAnnotationRule
-
- apply(ApiActionMetadata, JMethod) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringResponseBodyMethodAnnotationRule
-
- apply(ApiActionMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringResponseEntityRule
-
- apply(ApiActionMetadata, CodeModelHelper.JExtMethod) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRestClientMethodBodyRule
-
- apply(ApiResourceMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRestControllerAnnotationRule
-
- apply(ApiResourceMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRestTemplateFieldDeclerationRule
-
- apply(ApiActionMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringSimpleCallableResponseTypeRule
-
- apply(ApiActionMetadata, JDefinedClass) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringSimpleResponseTypeRule
-
- apply(ApiResourceMetadata, JCodeModel) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4RestTemplateClientRule
-
- applyConfiguration(Map<String, String>) - Method in interface com.phoenixnap.oss.ramlapisync.generation.rules.ConfigurableRule
-
Accepts a key-value representation of the the configurations and their respective values
- applyConfiguration(Map<String, String>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- applyConfiguration(Map<String, String>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4RestTemplateClientRule
-
- ARRAY_PARAMETER_CONFIGURATION - Static variable in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- ARRAY_PARAMETER_CONFIGURATION - Static variable in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4RestTemplateClientRule
-
- CALLABLE_RESPONSE_CONFIGURATION - Static variable in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- CAPITALISED_RESOURCE - Static variable in class com.phoenixnap.oss.ramlapisync.style.checkers.ResourceUrlStyleChecker
-
- CATCH_ALL_MEDIA_TYPE - Static variable in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
- check(RamlRoot, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckVisitorCoordinator
-
Performs a specific check across two Raml Models.
- check(RamlActionType, RamlAction, RamlAction, IssueLocation, IssueSeverity) - Method in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionContentTypeChecker
-
- check(String, RamlResource, RamlResource, IssueLocation, IssueSeverity) - Method in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionExistenceChecker
-
- check(RamlActionType, RamlAction, RamlAction, IssueLocation, IssueSeverity) - Method in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionQueryParameterChecker
-
- check(RamlActionType, RamlAction, RamlAction, IssueLocation, IssueSeverity) - Method in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionResponseBodySchemaChecker
-
- check(RamlRoot, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.verification.checkers.RamlCheckerResourceVisitorCoordinator
-
- check(RamlRoot, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.verification.checkers.ResourceExistenceChecker
-
- check(RamlActionType, RamlAction, RamlAction, IssueLocation, IssueSeverity) - Method in interface com.phoenixnap.oss.ramlapisync.verification.RamlActionVisitorCheck
-
Checks a particular action
- check(RamlRoot, RamlRoot) - Method in interface com.phoenixnap.oss.ramlapisync.verification.RamlChecker
-
Performs a specific check across two Raml Models.
- check(String, RamlResource, RamlResource, IssueLocation, IssueSeverity) - Method in interface com.phoenixnap.oss.ramlapisync.verification.RamlResourceVisitorCheck
-
Checks a particular resource
- checkActionStyle(RamlActionType, RamlAction, IssueLocation, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.style.checkers.ActionSecurityResponseChecker
-
- checkActionStyle(RamlActionType, RamlAction, IssueLocation, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.style.checkers.RequestBodySchemaStyleChecker
-
- checkActionStyle(RamlActionType, RamlAction, IssueLocation, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.style.checkers.ResponseBodySchemaStyleChecker
-
- checkActionStyle(RamlActionType, RamlAction, IssueLocation, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.style.checkers.ResponseCodeDefinitionStyleChecker
-
- checkActionStyle(RamlActionType, RamlAction, IssueLocation, RamlRoot) - Method in interface com.phoenixnap.oss.ramlapisync.style.RamlStyleChecker
-
Check the style of a particular action
- checkActionStyle(RamlActionType, RamlAction, IssueLocation, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckerAdapter
-
- checkParameterStyle(String, RamlAbstractParam) - Method in interface com.phoenixnap.oss.ramlapisync.style.RamlStyleChecker
-
Check the style of a particular parameter
- checkParameterStyle(String, RamlAbstractParam) - Method in class com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckerAdapter
-
- checkResource(String, RamlResource, ApiResourceMetadata, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.generation.RamlParser
-
Recursive method to parse resources in a Raml File.
- checkResourceStyle(String, RamlResource, IssueLocation, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.style.checkers.ResourceCollectionPluralisationChecker
-
- checkResourceStyle(String, RamlResource, IssueLocation, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.style.checkers.ResourceUrlStyleChecker
-
- checkResourceStyle(String, RamlResource, IssueLocation, RamlRoot) - Method in interface com.phoenixnap.oss.ramlapisync.style.RamlStyleChecker
-
Check the style of a particular resource.
- checkResourceStyle(String, RamlResource, IssueLocation, RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckerAdapter
-
- ClassAnnotationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Adds the specified annotation to the given JDefinedClass
- ClassAnnotationRule(Class<? extends Annotation>) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassAnnotationRule
-
- ClassCommentRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Generates a simple class comment.
- ClassCommentRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassCommentRule
-
- ClassFieldDeclarationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Creates a private field declaration for a RestTemplateClass with a Spring @Autowired annotation or a @Value
annotation with a customizable value.
- ClassFieldDeclarationRule(String, Class<?>, String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassFieldDeclarationRule
-
- ClassFieldDeclarationRule(String, Class<?>, boolean) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassFieldDeclarationRule
-
- ClassFieldDeclarationRule(String, Class<?>, boolean, String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassFieldDeclarationRule
-
- ClassFieldDeclarationRule(String, Class<?>) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassFieldDeclarationRule
-
- ClassVisitor - Class in com.phoenixnap.oss.ramlapisync.javadoc
-
Simple visitor implementation for visiting Class, Interface and MethodDeclaration nodes.
- ClassVisitor(JavaDocStore) - Constructor for class com.phoenixnap.oss.ramlapisync.javadoc.ClassVisitor
-
- cleanForJavadoc(String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Utility method to clean a string for use within javadoc
- cleanLeadingAndTrailingNewLineAndChars(String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Utility method to clean New Line,Spaces and other highly useless characters found (mainly in javadoc)
- CLIENT_SUFFIX - Static variable in class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClientInterfaceDeclarationRule
-
- ClientInterfaceDeclarationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Generates an interface declaration based on the controller name in ApiControllerMetadata.
- ClientInterfaceDeclarationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClientInterfaceDeclarationRule
-
- CodeModelHelper - Class in com.phoenixnap.oss.ramlapisync.generation
-
The class provides static helper methods for JCodeModel related tasks.
- CodeModelHelper() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.CodeModelHelper
-
- CodeModelHelper.JExtMethod - Class in com.phoenixnap.oss.ramlapisync.generation
-
Helper class because JMethod does not expose it's JCodeModel.
- com.phoenixnap.oss.ramlapisync.data - package com.phoenixnap.oss.ramlapisync.data
-
- com.phoenixnap.oss.ramlapisync.generation - package com.phoenixnap.oss.ramlapisync.generation
-
- com.phoenixnap.oss.ramlapisync.generation.exception - package com.phoenixnap.oss.ramlapisync.generation.exception
-
- com.phoenixnap.oss.ramlapisync.generation.rules - package com.phoenixnap.oss.ramlapisync.generation.rules
-
- com.phoenixnap.oss.ramlapisync.generation.rules.basic - package com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
- com.phoenixnap.oss.ramlapisync.generation.rules.spring - package com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
- com.phoenixnap.oss.ramlapisync.javadoc - package com.phoenixnap.oss.ramlapisync.javadoc
-
- com.phoenixnap.oss.ramlapisync.naming - package com.phoenixnap.oss.ramlapisync.naming
-
- com.phoenixnap.oss.ramlapisync.parser - package com.phoenixnap.oss.ramlapisync.parser
-
- com.phoenixnap.oss.ramlapisync.raml - package com.phoenixnap.oss.ramlapisync.raml
-
- com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1 - package com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
- com.phoenixnap.oss.ramlapisync.style - package com.phoenixnap.oss.ramlapisync.style
-
- com.phoenixnap.oss.ramlapisync.style.checkers - package com.phoenixnap.oss.ramlapisync.style.checkers
-
- com.phoenixnap.oss.ramlapisync.verification - package com.phoenixnap.oss.ramlapisync.verification
-
- com.phoenixnap.oss.ramlapisync.verification.checkers - package com.phoenixnap.oss.ramlapisync.verification.checkers
-
- ConfigurableRule<T,R,M> - Interface in com.phoenixnap.oss.ramlapisync.generation.rules
-
An Extension of the rule interface to represent rules that are configurable
- containsBodySchema(Map<String, RamlMimeType>, RamlRoot, boolean) - Static method in class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
Checks if a Map of mime types contains at least 1 valid JsonSchema.
- CONTRACT_MISSING - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ResourceExistenceChecker
-
- CONTROLLER_SUFFIX - Static variable in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- ControllerClassDeclarationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Generates an class declaration based on the controller name in ApiControllerMetadata.
- ControllerClassDeclarationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ControllerClassDeclarationRule
-
- ControllerClassDeclarationRule(String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ControllerClassDeclarationRule
-
- ControllerInterfaceDeclarationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Generates an interface declaration based on the controller name in ApiControllerMetadata.
- ControllerInterfaceDeclarationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ControllerInterfaceDeclarationRule
-
- ControllerMethodSignatureRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Generates a method signature for an endpoint defined by an ApiMappingMetadata instance.
- ControllerMethodSignatureRule(Rule<JDefinedClass, JType, ApiActionMetadata>, Rule<CodeModelHelper.JExtMethod, JMethod, ApiActionMetadata>) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ControllerMethodSignatureRule
-
- convertClassName(Class<?>) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Convert a class name into its restful Resource representation.
- convertClassToJsonSchema(ApiParameterMetadata, String, JavaDocStore) - Static method in class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
Uses Jackson object mappers to convert an ajaxcommandparameter annotated type into its
JSONSchema representation.
- convertClassToJsonSchema(Type, String, JavaDocStore) - Static method in class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
Uses Jackson object mappers to convert a Pojo into its JSONSchema representation.
- convertClassToQueryParameters(Parameter, JavaDocStore) - Static method in class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
Breaks down a class into component fields which are mapped as Query Parameters.
- convertContentTypeToQualifier(String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Converts an http contentType into a qualifier that can be used within a Java method
- convertParameterToQueryParameter(Parameter, String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
Converts a simple parameter, ie String, or Boxed Primitive into
- createRamlAction(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlAction() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlAction(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlAction() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlActionType(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlActionType(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlDocumentationItem() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlDocumentationItem(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlDocumentationItem() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlDocumentationItem(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlFormParameter() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlFormParameter(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlFormParameter() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlFormParameter(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlFormParameters(List<? extends Object>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlFormParameters(List<? extends Object>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlHeader(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlHeader(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlMimeType() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlMimeType(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlMimeType() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlMimeType(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlMimeTypeWithMime(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlMimeTypeWithMime(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlModelEmitter() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlModelEmitter() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlModelFactory() - Static method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactoryOfFactories
-
- createRamlParamType(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlParamType(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlQueryParameter() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlQueryParameter(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlQueryParameter() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlQueryParameter(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlResource() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlResource(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlResource() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlResource(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlResponse() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlResponse(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlResponse() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlResponse(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlRoot() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlRoot(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlRoot() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlRoot(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlSecurityReference(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlSecurityReference(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlSecurityReferences(List<? extends Object>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlSecurityReferences(List<? extends Object>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlUriParameter(Object) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlUriParameter(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- createRamlUriParameterWithName(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- createRamlUriParameterWithName(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- CSRF_HEADER - Static variable in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
- equals(Object) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiDocumentMetadata
-
- equals(Object) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- equals(Object) - Method in class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- ext(JMethod, JCodeModel) - Static method in class com.phoenixnap.oss.ramlapisync.generation.CodeModelHelper
-
- extractAndAppendResourceInfo(Class<?>, Method, JavaDocEntry, RamlResource) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Extracts relevant info from a Java method and converts it into a RAML resource
- extractAndAppendResourceInfo(Class<?>, Method, JavaDocEntry, RamlResource) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- extractControllers(RamlRoot) - Method in class com.phoenixnap.oss.ramlapisync.generation.RamlParser
-
This method will extract a set of controllers from the RAML file.
- extractExpectedMimeTypeFromMethod(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Checks the annotations and return type that the method returns and the mime it corresponds to
- extractExpectedMimeTypeFromMethod(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
Check for consumes annotation first.
- extractMimeTypeFromMethod(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Checks the annotations and return type that the method returns and the mime it corresponds to
- extractMimeTypeFromMethod(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
Check for produces annotation first.
- extractNameFromSchema(String, String, String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
Extracts the name from a schema in this order of precedence:
1.
- extractQueryParameters(RamlActionType, Method, Map<String, String>) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Extracts parameters from a method call and attaches these with the comments extracted from the javadoc
- extractRequestBody(Method, Map<String, String>, String, List<ApiParameterMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Converts a method body into a request json schema and a mime type.
- extractRequestBody(Method, Map<String, String>, String, List<ApiParameterMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- extractRequestBodyFromMethod(RamlActionType, Method, Map<String, String>) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Extracts the TOs and other parameters from a method and will convert into JsonSchema for inclusion in the body
TODO refactor this code structure
- extractResourceIdParameter(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Queries the parameters in the Method and checks for an AjaxParameter Annotation with the resource Id flag enabled
- extractResourceIdParameter(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- extractResourceInfo(Class<?>) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Extracts class information from a (believe it or not) java class as well as the contained methods.
- extractResponseFromMethod(Method, String) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Extracts the Response Body from a method in JsonSchema Format and embeds it into a response object based on the
defaultMediaType
- generateDocuments(Set<ApiDocumentMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.RamlGenerator
-
Parses the list of document models and adds them as RAML documentItem nodes in the RAML document.
- generateRamlForClasses(String, String, String, Class<?>[], Set<ApiDocumentMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.RamlGenerator
-
Parses classes array supplied and builds a Raml Model from any request mappings defined inside
- GenericJavaClassRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules
-
This is a configurable template rule which generates a Java artefact (class or interface)
based on an ApiControllerMetadata instance.
- GenericJavaClassRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- get() - Method in class com.phoenixnap.oss.ramlapisync.generation.CodeModelHelper.JExtMethod
-
- getAction() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getAction(RamlActionType) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- getAction(RamlActionType) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getAction() - Method in class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- getActionName(RamlResource, RamlResource, RamlAction, RamlActionType) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Attempts to infer the name of an action (intent) from a resource's relative URL and action details
- getActions() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- getActions() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getActionType() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getApiCalls() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getApiParameters(Method, boolean, boolean) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Allows children to specify which parameters within a method should be included in API generation
- getApiParameters(Method, boolean, boolean) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- getBasePackage() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getBaseUri() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlRoot
-
- getBaseUri() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- getBody() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- getBody() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResponse
-
- getBody() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- getBody() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResponse
-
- getCodeModel() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiBodyMetadata
-
- getCodeModel(String, String, GenerationConfig, Annotator) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiBodyMetadata
-
Builds a JCodeModel for this body
- getComment() - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocEntry
-
Returns the Main comment
- getConsumes() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getControllerAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerDecoratorRule
-
- getControllerAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerInterfaceRule
-
- getControllerAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerStubRule
-
- getControllerAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring3ControllerDecoratorRule
-
- getControllerAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring3ControllerInterfaceRule
-
- getControllerAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring3ControllerStubRule
-
- getControllerAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4ControllerDecoratorRule
-
- getControllerAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4ControllerInterfaceRule
-
- getControllerAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4ControllerStubRule
-
- getControllerUrl() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getDefaultGenerationConfig() - Static method in class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
Returns a configuration for the JSON Schema 2 POJO that is in line with the defaults used in
the plugin so far
- getDefaultModelPackage() - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Returns the default sub package that will be used for model objects used in the Request/Response body
- getDefaultValue() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- getDefaultValue() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlQueryParameter
-
- getDefaultValue() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- getDefaultValue() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- getDefaultValue() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getDefaultValue() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- getDependencies() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- getDescription() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- getDescription() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- getDescription() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResponse
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResponse
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- getDescription() - Method in class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- getDisplayName() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- getDisplayName() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- getDisplayName() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- getDisplayName() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getDisplayName() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- getDocument() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getDocumentPath() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiDocumentMetadata
-
Gets the path to the document relative to the Raml file
- getDocumentTitle() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiDocumentMetadata
-
- getErrorComments() - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocEntry
-
Gets the Exception comments //TODO
- getErrors() - Method in class com.phoenixnap.oss.ramlapisync.generation.RamlVerifier
-
Retrieve the Errors identified
- getExample() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
The example which is set with this parameter
- getExample() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- getExample() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- getExample() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- getExample() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getExample() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- getFirst() - Method in class com.phoenixnap.oss.ramlapisync.naming.Pair
-
- getFormParameters() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlMimeType
-
- getFormParameters() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlMimeType
-
- getGenerationConfig(Boolean, Boolean, Boolean, Boolean) - Static method in class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
Returns a generation config with the supplied parameters.
- getGenericType() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
The Java Type of the generic portion of the parameter
- getGenericType(Parameter) - Static method in class com.phoenixnap.oss.ramlapisync.naming.TypeHelper
-
Attempts to infer the type in the generic part of the declaration of the type
- getHeaders() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- getHeaders() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- getHttpMethodAndName(Class<?>, Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Extracts the http method (verb) as well as the name of the api call
- getHttpMethodAndName(Class<?>, Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- getInjectHttpHeadersParameter() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getJavaDoc(Class<?>) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocExtractor
-
Extracts the Java Doc for a specific class from its Source code as well as any superclasses or implemented
interfaces.
- getJavaDoc(Method) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocStore
-
- getJavaDoc(String, int) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocStore
-
- getJavaDoc(String) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocStore
-
- getJavaDocComment(Class<?>) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocStore
-
- getJavaName() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
Gets the name of the parameter as specified in Java (ignores any annotations)
- getLocation() - Method in class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- getMaximum() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlQueryParameter
-
- getMaximum() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getMaxLength() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlQueryParameter
-
- getMaxLength() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getMediaType() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlRoot
-
- getMediaType() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- getMinimum() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlQueryParameter
-
- getMinimum() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getMinLength() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlQueryParameter
-
- getMinLength() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getName() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getName() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiBodyMetadata
-
- getName() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
The Parameter Name in RAML
- getName() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getName() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlSecurityReference
-
- getName() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlSecurityReference
-
- getParameterComments() - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocEntry
-
Returns the Parameter Comments
- getParameterName(String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Converts the name of a parameter into a name suitable for a Java parameter
- getParameterName(String, String) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- getParent() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getParentResource() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- getParentResource() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getParentUri() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- getParentUri() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getPathDescriptionsForMethod(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
Checks for instances of @Description annotations in
- getPathVariables() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getPattern() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlQueryParameter
-
- getPattern() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getProduces() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getQueryParameters() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- getQueryParameters() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- getRaml() - Method in class com.phoenixnap.oss.ramlapisync.generation.RamlGenerator
-
Returns the RAML Model
- getRamlLocation() - Method in class com.phoenixnap.oss.ramlapisync.verification.Issue
-
Gets the location of the Issue as a string, or builds it from the Resource/Action/Parameter info stored.
- getRamlOutputFile(String) - Method in class com.phoenixnap.oss.ramlapisync.generation.RamlGenerator
-
Takes the absolute path and gets the Raml file to be created
- getRamlParam() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
- getRelativeUri() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- getRelativeUri() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getRequestBody() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getRequestBodyMime() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getRequestHeaders() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getRequestParameters() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getResolvedUriParameters() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- getResolvedUriParameters() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getResource() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getResource() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getResource() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- getResource(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResourceRoot
-
- getResource() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- getResource(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getResource(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- getResourceLocation() - Method in class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- getResourceName() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getResourceName(RamlResource, boolean) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Attempts to infer the name of a resource from a resources's relative URL
- getResourceName(String, boolean) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Attempts to infer the name of a resource from a resources's relative URL
- getResourceName(Class<?>) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Extracts the name of the resource that this class manages
- getResourceName(Class<?>) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- getResources() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResourceRoot
-
- getResources() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getResources() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- getResourceUri() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- getResponseBody() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getResponseBodyAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerDecoratorRule
-
- getResponseBodyAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerInterfaceRule
-
- getResponseBodyAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerStubRule
-
- getResponseBodyAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring3ControllerDecoratorRule
-
- getResponseBodyAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring3ControllerInterfaceRule
-
- getResponseBodyAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring3ControllerStubRule
-
- getResponseBodyAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4ControllerDecoratorRule
-
- getResponseBodyAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4ControllerInterfaceRule
-
- getResponseBodyAnnotationRule() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4ControllerStubRule
-
- getResponses() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- getResponses() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- getReturnTypeComment() - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocEntry
-
returns the comment for the return type
- getSchema() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiBodyMetadata
-
- getSchema() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlMimeType
-
- getSchema() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlMimeType
-
- getSchemas() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlRoot
-
- getSchemas() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- getSecond() - Method in class com.phoenixnap.oss.ramlapisync.naming.Pair
-
- getSecuredBy() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- getSecuredBy() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- getSeverity() - Method in class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- getSuccessfulResponse(RamlAction) - Static method in class com.phoenixnap.oss.ramlapisync.naming.RamlHelper
-
Gets the successful response from an action (200 or 201)
- getType() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
The Java Type of the parameter
- getType() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- getType() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- getType() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- getType() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- getType() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- getType() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- getType() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- getType() - Method in class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- getUri() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- getUri() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getUriParameters() - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- getUriParameters() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- getUrl() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- getVersion() - Static method in class com.phoenixnap.oss.ramlapisync.generation.CodeModelHelper
-
- getWarnings() - Method in class com.phoenixnap.oss.ramlapisync.generation.RamlVerifier
-
Retrieve the Warnings identified
- ID_RESOURCE_REGEX - Static variable in class com.phoenixnap.oss.ramlapisync.style.checkers.ResourceCollectionPluralisationChecker
-
- identity(T) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlModelFactory
-
- IGNORE_METHOD_REGEX - Static variable in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
- IMPLEMENTATION_MISSING - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ResourceExistenceChecker
-
- ImplementMeMethodBodyRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Generates an empty method body returning null and a TODO comment.
- ImplementMeMethodBodyRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ImplementMeMethodBodyRule
-
- ImplementsControllerInterfaceRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Generates an implements expression based on a given JDefinedClass.
- ImplementsControllerInterfaceRule(JDefinedClass) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ImplementsControllerInterfaceRule
-
- INCOMPATIBLE_TYPES - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionQueryParameterChecker
-
- INCOMPATIBLE_VALIDATION - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionQueryParameterChecker
-
- inferGenericType(Type) - Static method in class com.phoenixnap.oss.ramlapisync.naming.TypeHelper
-
Attempts to infer the type in the generic part of the declaration of the type
- injectHttpHeadersParameter - Variable in class com.phoenixnap.oss.ramlapisync.generation.RamlParser
-
If set to true, we will add a HttpHeaders parameter in the action methods
- InvalidCodeModelException - Exception in com.phoenixnap.oss.ramlapisync.generation.exception
-
A runtime exception telling the caller that there is a problem with the CodeModel.
- InvalidCodeModelException(String) - Constructor for exception com.phoenixnap.oss.ramlapisync.generation.exception.InvalidCodeModelException
-
- InvalidCodeModelException(String, Throwable) - Constructor for exception com.phoenixnap.oss.ramlapisync.generation.exception.InvalidCodeModelException
-
- isActionOnResourceWithoutCommand(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Checks is this api call is made directly on a resource without a trailing command in the URL.
- isActionOnResourceWithoutCommand(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- isAddParameterJavadoc() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- isAllowArrayParameters() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- isAnnotationPresent(Class<? extends Annotation>) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
Checks if the param is annotated by a particular annotation
- isArray() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiBodyMetadata
-
- isArray() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
Quick check to see if this is an array type or not
- isCallableResponse() - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- isNonPathParameter(Parameter) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- isNullable() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
Can this parameter be passed in as null
- isParameter(Parameter) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- isPathParameter(Parameter) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- isQueryParameter(Parameter) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Allows children to specify whether a parameter should be included when generating query parameters for a method
- isQueryParameter(Parameter) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- isRepeat() - Method in class com.phoenixnap.oss.ramlapisync.data.RamlFormParameter
-
- isRepeat() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
Convenience method for easier processing.
- isRepeat() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlQueryParameter
-
- isRepeat() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- isRepeat() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- isRequired() - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- isRequired() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- isRequired() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- isRequired() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- isRequired() - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- isResourceId() - Method in class com.phoenixnap.oss.ramlapisync.data.ApiParameterMetadata
-
Is this parameter the identifying parameter to the rest resource.
- Issue - Class in com.phoenixnap.oss.ramlapisync.verification
-
Data object which identifies a discrepancy between two RAML models
- Issue(IssueSeverity, IssueLocation, IssueType, String, RamlResource, RamlAction, String) - Constructor for class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- Issue(IssueSeverity, IssueLocation, IssueType, String, RamlResource, RamlAction) - Constructor for class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- Issue(IssueSeverity, IssueLocation, IssueType, String, String) - Constructor for class com.phoenixnap.oss.ramlapisync.verification.Issue
-
- IssueLocation - Enum in com.phoenixnap.oss.ramlapisync.verification
-
The Source locations of the Issue
- IssueSeverity - Enum in com.phoenixnap.oss.ramlapisync.verification
-
Different Levels of severity associated with an Issue
- IssueType - Enum in com.phoenixnap.oss.ramlapisync.verification
-
Different Levels of severity associated with an Issue
- isUriParamResource(String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Checks if a Resource URI fragment is a URI Parameter.
- isValidJavaClassName(String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Utility method to check if a string can be used as a valid class name
- RamlAbstractParam - Class in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Parameter
- RamlAbstractParam() - Constructor for class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- RamlAction - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Action
- RamlActionType - Enum in com.phoenixnap.oss.ramlapisync.raml
-
Enumeration of a Raml Action Types
- RamlActionVisitorCheck - Interface in com.phoenixnap.oss.ramlapisync.verification
-
A visitor that will be invoked when an action is identified
- RamlChecker - Interface in com.phoenixnap.oss.ramlapisync.verification
-
Parent Interface for all Raml Checkers.
- RamlCheckerResourceVisitorCoordinator - Class in com.phoenixnap.oss.ramlapisync.verification.checkers
-
Raml checker that cross checks Resources between 2 RAML models.
- RamlCheckerResourceVisitorCoordinator(List<RamlActionVisitorCheck>, List<RamlResourceVisitorCheck>) - Constructor for class com.phoenixnap.oss.ramlapisync.verification.checkers.RamlCheckerResourceVisitorCoordinator
-
- RamlDocumentationItem - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Documentation item
- RamlFormParameter - Class in com.phoenixnap.oss.ramlapisync.data
-
- RamlFormParameter() - Constructor for class com.phoenixnap.oss.ramlapisync.data.RamlFormParameter
-
- RamlGenerator - Class in com.phoenixnap.oss.ramlapisync.generation
-
Class containing RAML generation driver.
- RamlGenerator() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.RamlGenerator
-
Default constructor.
- RamlGenerator(ResourceParser) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.RamlGenerator
-
- RamlHeader - Class in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Header
- RamlHeader() - Constructor for class com.phoenixnap.oss.ramlapisync.raml.RamlHeader
-
- RamlHelper - Class in com.phoenixnap.oss.ramlapisync.naming
-
Class containing utility methods for modifying Raml models
- RamlHelper() - Constructor for class com.phoenixnap.oss.ramlapisync.naming.RamlHelper
-
- RamlMimeType - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml MimeType
- RamlModelEmitter - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Writer
- RamlModelFactory - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Factory
- RamlModelFactoryOfFactories - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Factory which creates Raml Factory.
- RamlParamType - Enum in com.phoenixnap.oss.ramlapisync.raml
-
Enumeration of a Raml Types
- RamlParser - Class in com.phoenixnap.oss.ramlapisync.generation
-
Class containing methods that are used to parse raml files for code generation from the RAML
- RamlParser(String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.RamlParser
-
- RamlParser(String, String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.RamlParser
-
- RamlParser(String, String, boolean, boolean) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.RamlParser
-
- RamlQueryParameter - Class in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Query Parameter
- RamlQueryParameter() - Constructor for class com.phoenixnap.oss.ramlapisync.raml.RamlQueryParameter
-
- RamlResource - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Resource
- RamlResourceRoot - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Resource
- RamlResourceVisitorCheck - Interface in com.phoenixnap.oss.ramlapisync.verification
-
A visitor that will be invoked when an resource is identified
- RamlResponse - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Response
- RamlRoot - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Document root
- RamlSecurityReference - Interface in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Security Reference
- RamlStyleChecker - Interface in com.phoenixnap.oss.ramlapisync.style
-
Parent Interface for all Raml Style Checkers.
- RamlStyleCheckerAdapter - Class in com.phoenixnap.oss.ramlapisync.style
-
Adapter pattern for Raml Style Checkers.
- RamlStyleCheckerAdapter() - Constructor for class com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckerAdapter
-
- RamlStyleCheckVisitorCoordinator - Class in com.phoenixnap.oss.ramlapisync.style
-
Provides a Vistor pattern approach to Style Checks.
- RamlStyleCheckVisitorCoordinator(List<RamlStyleChecker>) - Constructor for class com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckVisitorCoordinator
-
- RamlUriParameter - Class in com.phoenixnap.oss.ramlapisync.raml
-
Abstract Representation of a Raml Uri Parameter
- RamlUriParameter() - Constructor for class com.phoenixnap.oss.ramlapisync.raml.RamlUriParameter
-
- RamlVerifier - Class in com.phoenixnap.oss.ramlapisync.generation
-
Engine that aims to compare RAML as loaded from a raml file that is published as our API contract with RAML generated from the Spring MVC implementation
- RamlVerifier(RamlRoot, RamlRoot, List<RamlChecker>, List<RamlActionVisitorCheck>, List<RamlResourceVisitorCheck>, List<RamlStyleChecker>) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.RamlVerifier
-
Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify.
- RamlVerifier(RamlRoot, RamlRoot, List<RamlChecker>, List<RamlActionVisitorCheck>, List<RamlResourceVisitorCheck>, List<RamlStyleChecker>, String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.RamlVerifier
-
Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify.
- RamlVerifier(RamlRoot, RamlRoot, List<RamlChecker>, List<RamlActionVisitorCheck>, List<RamlResourceVisitorCheck>) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.RamlVerifier
-
Constructor which will accept target/implementation RAML models as well as the the checkers to be applied.
- removeResource(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResourceRoot
-
- removeResource(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- removeResource(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- removeResourceTree(RamlRoot, String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.RamlHelper
-
Removes a section of the tree from the resources in a Raml model and moves all sub resources to the root
- REQUEST_BODY_MISSING - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionContentTypeChecker
-
- RequestBodySchemaStyleChecker - Class in com.phoenixnap.oss.ramlapisync.style.checkers
-
Style checker that will check for existance of valid schemas in request bodies
- RequestBodySchemaStyleChecker(String) - Constructor for class com.phoenixnap.oss.ramlapisync.style.checkers.RequestBodySchemaStyleChecker
-
- REQUIRED_PARAM_HIDDEN - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionQueryParameterChecker
-
- resolveProperties(String) - Static method in class com.phoenixnap.oss.ramlapisync.naming.NamingHelper
-
Attempts to load system propertes from the string or use included defaults if available
- resolveSchema(String, RamlRoot) - Static method in class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
Utility method that will return a schema if the identifier is valid and exists in the raml
file definition.
- RESOURCE_MISSING - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ResourceExistenceChecker
-
- RESOURCE_WITH_DISCREPANCY - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ResourceExistenceChecker
-
- ResourceClassDeclarationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Generates an class declaration based on the controller name in ApiControllerMetadata.
- ResourceClassDeclarationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ResourceClassDeclarationRule
-
- ResourceClassDeclarationRule(String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.ResourceClassDeclarationRule
-
- ResourceCollectionPluralisationChecker - Class in com.phoenixnap.oss.ramlapisync.style.checkers
-
Style checker that ensures that collection resources are defined in the plural form
- ResourceCollectionPluralisationChecker() - Constructor for class com.phoenixnap.oss.ramlapisync.style.checkers.ResourceCollectionPluralisationChecker
-
- ResourceExistenceChecker - Class in com.phoenixnap.oss.ramlapisync.verification.checkers
-
Raml checker that cross checks the existence of Resources
- ResourceExistenceChecker() - Constructor for class com.phoenixnap.oss.ramlapisync.verification.checkers.ResourceExistenceChecker
-
- ResourceParser - Class in com.phoenixnap.oss.ramlapisync.parser
-
Common service scanning functionality
- ResourceParser(File, String, String) - Constructor for class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
- ResourceUrlStyleChecker - Class in com.phoenixnap.oss.ramlapisync.style.checkers
-
Style checker that ensures that certain characters are not used in resource URLs
- ResourceUrlStyleChecker() - Constructor for class com.phoenixnap.oss.ramlapisync.style.checkers.ResourceUrlStyleChecker
-
- RESPONSE_BODY_DIFFERENTSIZE - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionResponseBodySchemaChecker
-
- RESPONSE_BODY_FIELDDIFFERENT - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionResponseBodySchemaChecker
-
- RESPONSE_BODY_FIELDMISSING - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionResponseBodySchemaChecker
-
- RESPONSE_BODY_MISSING - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionContentTypeChecker
-
- RESPONSE_BODY_MISSING - Static variable in class com.phoenixnap.oss.ramlapisync.verification.checkers.ActionResponseBodySchemaChecker
-
- ResponseBodySchemaStyleChecker - Class in com.phoenixnap.oss.ramlapisync.style.checkers
-
Style checker that will check for existance of valid schemas in request bodies
- ResponseBodySchemaStyleChecker(String) - Constructor for class com.phoenixnap.oss.ramlapisync.style.checkers.ResponseBodySchemaStyleChecker
-
- ResponseCodeDefinitionStyleChecker - Class in com.phoenixnap.oss.ramlapisync.style.checkers
-
Style checker that will check for existence of valid schemas in request bodies
- ResponseCodeDefinitionStyleChecker(MultiValueMap<String, HttpStatus>) - Constructor for class com.phoenixnap.oss.ramlapisync.style.checkers.ResponseCodeDefinitionStyleChecker
-
- restrictOnMediaType - Variable in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
IF this is set to true, we will only parse methods that consume, produce or accept the requested defaultMediaType
- RJP08V1RamlAction - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlAction(Action) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- RJP08V1RamlDocumentationItem - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlDocumentationItem(DocumentationItem) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlDocumentationItem
-
- RJP08V1RamlFormParameter - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlFormParameter(FormParameter) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- RJP08V1RamlHeader - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlHeader(Header) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- RJP08V1RamlMimeType - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlMimeType(MimeType) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlMimeType
-
- RJP08V1RamlModelEmitter - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlModelEmitter() - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelEmitter
-
- RJP08V1RamlModelFactory - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlModelFactory() - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlModelFactory
-
- RJP08V1RamlQueryParameter - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlQueryParameter(QueryParameter) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- RJP08V1RamlResource - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlResource(Resource) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- RJP08V1RamlResponse - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlResponse(Response) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResponse
-
- RJP08V1RamlRoot - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlRoot(Raml) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- RJP08V1RamlSecurityReference - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlSecurityReference(SecurityReference) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlSecurityReference
-
- RJP08V1RamlUriParameter - Class in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
-
Implementation based on the Raml 0.8 Parser
- RJP08V1RamlUriParameter(UriParameter) - Constructor for class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- Rule<T,R,M> - Interface in com.phoenixnap.oss.ramlapisync.generation.rules
-
Represents a generic code generation rule (e.g.
- RuleCanNotProcessModelException - Exception in com.phoenixnap.oss.ramlapisync.generation.exception
-
An exception that tells the user that a rule can't process the given RAML model.
- RuleCanNotProcessModelException(String) - Constructor for exception com.phoenixnap.oss.ramlapisync.generation.exception.RuleCanNotProcessModelException
-
- RuleCanNotProcessModelException(String, Throwable) - Constructor for exception com.phoenixnap.oss.ramlapisync.generation.exception.RuleCanNotProcessModelException
-
- SchemaHelper - Class in com.phoenixnap.oss.ramlapisync.naming
-
Class containing convenience methods relating to the extracting of information from Java types
for use as Parameters.
- SchemaHelper() - Constructor for class com.phoenixnap.oss.ramlapisync.naming.SchemaHelper
-
- seperateMethodsByContentType - Variable in class com.phoenixnap.oss.ramlapisync.generation.RamlParser
-
If set to true, we will generate seperate methods for different content types in the RAML
- setAction(RamlAction) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- setActionType(RamlActionType) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- setAddParameterJavadoc(boolean) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- setAllowArrayParameters(boolean) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- setBaseUri(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlRoot
-
- setBaseUri(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- setBody(Map<String, RamlMimeType>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- setBody(Map<String, RamlMimeType>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResponse
-
- setBody(Map<String, RamlMimeType>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- setBody(Map<String, RamlMimeType>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResponse
-
- setCallableResponse(boolean) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- setClassCommentRule(Rule<JDefinedClass, JDocComment, ApiResourceMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- setClassJavaDoc(String) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocStore
-
- setClassRule(Rule<JPackage, JDefinedClass, ApiResourceMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- setContent(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlDocumentationItem
-
- setContent(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlDocumentationItem
-
- setDescription(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- setDescription(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- setDescription(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- setDescription(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResponse
-
- setDescription(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- setDescription(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- setDescription(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- setDescription(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- setDescription(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- setDescription(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResponse
-
- setDescription(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- setDisplayName(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- setDisplayName(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- setDisplayName(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- setDisplayName(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- setDisplayName(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- setDisplayName(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- setDisplayName(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- setDocumentation(List<RamlDocumentationItem>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlRoot
-
- setDocumentation(List<RamlDocumentationItem>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- setExample(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- setExample(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlMimeType
-
- setExample(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- setExample(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- setExample(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlMimeType
-
- setExample(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- setExample(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- setFirst(K) - Method in class com.phoenixnap.oss.ramlapisync.naming.Pair
-
- setFormParameters(Map<String, List<RamlFormParameter>>) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlMimeType
-
- setFormParameters(Map<String, List<RamlFormParameter>>) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlMimeType
-
- setImplementsExtendsRule(Rule<JDefinedClass, JDefinedClass, ApiResourceMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- setJavaDoc(Class<?>, String) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocStore
-
- setJavaDoc(Method, String) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocStore
-
- setJavaDoc(String, String) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocStore
-
- setJavaDoc(String, int, String) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.JavaDocStore
-
- setJavaDocs(JavaDocExtractor) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Update JavaDoc extractor
- setMediaType(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlRoot
-
- setMediaType(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- setMethodBodyRule(Rule<CodeModelHelper.JExtMethod, JMethod, ApiActionMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- setMethodCommentRule(Rule<JMethod, JDocComment, ApiActionMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- setMethodSignatureRule(Rule<JDefinedClass, JMethod, ApiActionMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- setPackageRule(Rule<JCodeModel, JPackage, ApiResourceMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.generation.rules.GenericJavaClassRule
-
- setParent(ApiResourceMetadata) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- setParentResource(RamlResource) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- setParentResource(RamlResource) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- setParentUri(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- setParentUri(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- setPathVariables(Set<ApiParameterMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- setRamlMediaType(String) - Method in class com.phoenixnap.oss.ramlapisync.generation.RamlGenerator
-
Adds a global media type to the document
- setRelativeUri(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlResource
-
- setRelativeUri(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlResource
-
- setRepeat(boolean) - Method in class com.phoenixnap.oss.ramlapisync.data.RamlFormParameter
-
- setRepeat(boolean) - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlQueryParameter
-
- setRepeat(boolean) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- setRepeat(boolean) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- setRequestBodyMime(String) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- setRequestParameters(Set<ApiParameterMetadata>) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- setRequired(boolean) - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- setRequired(boolean) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- setRequired(boolean) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- setRequired(boolean) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- setRequired(boolean) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- setResource(RamlResource) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiActionMetadata
-
- setResource(RamlResource) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- setResource(RamlResource) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- setSchema(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlMimeType
-
- setSchema(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlMimeType
-
- setSecond(Y) - Method in class com.phoenixnap.oss.ramlapisync.naming.Pair
-
- setSingularizeName(boolean) - Method in class com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata
-
- setTitle(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlDocumentationItem
-
- setTitle(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlRoot
-
- setTitle(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlDocumentationItem
-
- setTitle(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- setType(RamlParamType) - Method in class com.phoenixnap.oss.ramlapisync.raml.RamlAbstractParam
-
- setType(RamlActionType) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlAction
-
- setType(RamlActionType) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlAction
-
- setType(RamlParamType) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlFormParameter
-
- setType(RamlParamType) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlHeader
-
- setType(RamlParamType) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlQueryParameter
-
- setType(RamlParamType) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlUriParameter
-
- setVersion(String) - Method in interface com.phoenixnap.oss.ramlapisync.raml.RamlRoot
-
- setVersion(String) - Method in class com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1.RJP08V1RamlRoot
-
- shouldAddMethodToApi(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
Allows child Scanners to add their own logic on whether a method should be treated as an API or ignored
- shouldAddMethodToApi(Method) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- shouldAddParameter(Parameter) - Method in class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
Checks if a parameter has any metadata that has been attached using the RequestParam data which identifies it as
an API request parameter
- SPECIAL_CHARS_IN_URL - Static variable in class com.phoenixnap.oss.ramlapisync.style.checkers.ResourceUrlStyleChecker
-
- Spring3ControllerDecoratorRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules
-
A code generation Rule that provides a Spring4 Controller based on a decorator pattern.
- Spring3ControllerDecoratorRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.Spring3ControllerDecoratorRule
-
- Spring3ControllerInterfaceRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules
-
A code generation Rule that provides a standalone Controller interface with Spring4 annotations.
- Spring3ControllerInterfaceRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.Spring3ControllerInterfaceRule
-
- Spring3ControllerStubRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules
-
A code generation Rule that provides a simple Controller stub class with Spring4 annotations and empty method bodies.
- Spring3ControllerStubRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.Spring3ControllerStubRule
-
- Spring4ControllerDecoratorRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules
-
A code generation Rule that provides a Spring4 Controller based on a decorator pattern.
- Spring4ControllerDecoratorRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4ControllerDecoratorRule
-
- Spring4ControllerInterfaceRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules
-
A code generation Rule that provides a standalone Controller interface with Spring4 annotations.
- Spring4ControllerInterfaceRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4ControllerInterfaceRule
-
- Spring4ControllerStubRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules
-
A code generation Rule that provides a simple Controller stub class with Spring4 annotations and empty method bodies.
- Spring4ControllerStubRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4ControllerStubRule
-
- Spring4RestTemplateClientRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules
-
Builds a client from a parsed RAML document.
- Spring4RestTemplateClientRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.Spring4RestTemplateClientRule
-
- SpringCallableResponseEntityRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Creates a
Callable as a return type for an endpoint.
- SpringCallableResponseEntityRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringCallableResponseEntityRule
-
- SpringConfigurableRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Common parent for configurable spring rules
- SpringConfigurableRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringConfigurableRule
-
- SpringControllerDecoratorRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
A code generation Rule that provides a Spring4 Controller based on a decorator pattern.
- SpringControllerDecoratorRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerDecoratorRule
-
- SpringControllerInterfaceRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
A code generation Rule that provides a standalone Controller interface with Spring4 annotations.
- SpringControllerInterfaceRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerInterfaceRule
-
- SpringControllerStubRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
A code generation Rule that provides a simple Controller stub class with Spring4 annotations and empty method bodies.
- SpringControllerStubRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringControllerStubRule
-
- SpringDelegateFieldDeclerationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Creates a private field declaration with a Spring @Autowired annotation.
- SpringDelegateFieldDeclerationRule(String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringDelegateFieldDeclerationRule
-
- SpringFeignClientClassAnnotationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Adds a @FeignClient annotation at class level.
- SpringFeignClientClassAnnotationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringFeignClientClassAnnotationRule
-
- SpringFeignClientInterfaceDeclarationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.basic
-
Generates an interface declaration based on the controller name in ApiControllerMetadata.
- SpringFeignClientInterfaceDeclarationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.basic.SpringFeignClientInterfaceDeclarationRule
-
- SpringFeignClientInterfaceDecoratorRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
A code generation Rule that provides a standalone FeignClient.
- SpringFeignClientInterfaceDecoratorRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringFeignClientInterfaceDecoratorRule
-
- SpringFeignClientInterfaceRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules
-
A code generation Rule that provides a standalone FeignClient.
- SpringFeignClientInterfaceRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.SpringFeignClientInterfaceRule
-
- SpringFeignClientResponseTypeRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Creates a ResponseEntity as a return type for an endpoint.
- SpringFeignClientResponseTypeRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringFeignClientResponseTypeRule
-
- SpringMethodParamsRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Generates all method parameters with Spring annotations needed for an endpoint defined by ApiMappingMetadata.
- SpringMethodParamsRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringMethodParamsRule
-
- SpringMethodParamsRule(boolean, boolean) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringMethodParamsRule
-
- SpringMvcResourceParser - Class in com.phoenixnap.oss.ramlapisync.parser
-
Service scanner that handles generation from a Spring MVC codebase
- SpringMvcResourceParser(File, String, String, boolean) - Constructor for class com.phoenixnap.oss.ramlapisync.parser.SpringMvcResourceParser
-
- SpringRequestMappingClassAnnotationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Adds a @RequestMapping annotation at class level
The "value" of the @RequestMapping is the controller url from the ApiControllerMetadata instance.
- SpringRequestMappingClassAnnotationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRequestMappingClassAnnotationRule
-
- SpringRequestMappingMethodAnnotationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Adds a @RequestMapping annotation at method level.
- SpringRequestMappingMethodAnnotationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRequestMappingMethodAnnotationRule
-
- SpringResponseBodyMethodAnnotationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Adds a @ResponseBody annotation to the method if there is response body declared in this endpoints metadata.
- SpringResponseBodyMethodAnnotationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringResponseBodyMethodAnnotationRule
-
- SpringResponseEntityRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Creates a org.springframework.http.ResponseEntity as a return type for an endpoint.
- SpringResponseEntityRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringResponseEntityRule
-
- SpringRestClientMethodBodyRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Generates a method body that calls the rest template to execute a REST call.
- SpringRestClientMethodBodyRule(String, String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRestClientMethodBodyRule
-
- SpringRestControllerAnnotationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Adds the @Controller or @RestController (depending on Spring Version - 4 by default) annotation to the given JDefinedClass
- SpringRestControllerAnnotationRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRestControllerAnnotationRule
-
- SpringRestControllerAnnotationRule(int) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRestControllerAnnotationRule
-
- SpringRestTemplateFieldDeclerationRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Creates a private field declaration with a Spring @Autowired annotation.
- SpringRestTemplateFieldDeclerationRule(String) - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringRestTemplateFieldDeclerationRule
-
- SpringSimpleCallableResponseTypeRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Creates a org.springframework.http.ResponseEntity as a return type for an endpoint.
- SpringSimpleCallableResponseTypeRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringSimpleCallableResponseTypeRule
-
- SpringSimpleResponseTypeRule - Class in com.phoenixnap.oss.ramlapisync.generation.rules.spring
-
Creates a org.springframework.http.ResponseEntity as a return type for an endpoint.
- SpringSimpleResponseTypeRule() - Constructor for class com.phoenixnap.oss.ramlapisync.generation.rules.spring.SpringSimpleResponseTypeRule
-
- StyleIssue - Class in com.phoenixnap.oss.ramlapisync.style
-
A specific type of issue relating to style
- StyleIssue(IssueLocation, String, RamlResource, RamlAction) - Constructor for class com.phoenixnap.oss.ramlapisync.style.StyleIssue
-
- StyleIssue(IssueLocation, String, String) - Constructor for class com.phoenixnap.oss.ramlapisync.style.StyleIssue
-
- valueOf(String) - Static method in enum com.phoenixnap.oss.ramlapisync.raml.RamlActionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.phoenixnap.oss.ramlapisync.raml.RamlParamType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.phoenixnap.oss.ramlapisync.verification.IssueLocation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.phoenixnap.oss.ramlapisync.verification.IssueSeverity
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.phoenixnap.oss.ramlapisync.verification.IssueType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.phoenixnap.oss.ramlapisync.raml.RamlActionType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.phoenixnap.oss.ramlapisync.raml.RamlParamType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.phoenixnap.oss.ramlapisync.verification.IssueLocation
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.phoenixnap.oss.ramlapisync.verification.IssueSeverity
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.phoenixnap.oss.ramlapisync.verification.IssueType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- version - Variable in class com.phoenixnap.oss.ramlapisync.parser.ResourceParser
-
- visit(ClassOrInterfaceDeclaration, String) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.ClassVisitor
-
Visit classes and extract javadoc entries to be stored in the supplied JavaDocStore
- visit(FieldDeclaration, String) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.FieldVisitor
-
- visit(MethodDeclaration, String) - Method in class com.phoenixnap.oss.ramlapisync.javadoc.MethodVisitor
-