com.phoenixnap.oss.ramlapisync.style

Interface RamlStyleChecker

All Known Implementing Classes:

ActionSecurityResponseChecker, RamlStyleCheckerAdapter, RequestBodySchemaStyleChecker, ResourceCollectionPluralisationChecker, ResourceUrlStyleChecker, ResponseBodySchemaStyleChecker, ResponseCodeDefinitionStyleChecker

public interface RamlStyleChecker

Parent Interface for all Raml Style Checkers. Implement this interface and add it to the RamlStyleCheckCoordinator to enable this check

Since:

0.0.2

Author:

Kurt Paris

Method Summary

Modifier and Type	Method and Description
Set<StyleIssue>	checkActionStyle(RamlActionType key, RamlAction value, IssueLocation location, RamlRoot raml) Check the style of a particular action
Set<StyleIssue>	checkParameterStyle(String name, RamlAbstractParam param) Check the style of a particular parameter
Set<StyleIssue>	checkResourceStyle(String name, RamlResource resource, IssueLocation location, RamlRoot raml) Check the style of a particular resource.

Method Detail

checkParameterStyle

Set<StyleIssue> checkParameterStyle(String name,
                                    RamlAbstractParam param)

Check the style of a particular parameter

Parameters:

name - The parameter name to be checked

param - The Parameter from the RAML Model

Returns:

A list of style issues or an Empty List if none are found. This method must not return null.

checkActionStyle

Set<StyleIssue> checkActionStyle(RamlActionType key,
                                 RamlAction value,
                                 IssueLocation location,
                                 RamlRoot raml)

Check the style of a particular action

Parameters:

key - The action's verb

value - The Action from the RAML model

location - The location where the issue (if any) lies

raml - The Raml Document being checked

Returns:

A list of style issues or an Empty List if none are found. This method must not return null.

checkResourceStyle

Set<StyleIssue> checkResourceStyle(String name,
                                   RamlResource resource,
                                   IssueLocation location,
                                   RamlRoot raml)

Check the style of a particular resource. This will be called on all child resources by the coordinator.

Parameters:

name - The name of the resource (relative URL)

resource - The Resource from the RAML model

location - The location where the issue (if any) lies

raml - The Raml Document being checked

Returns:

A list of style issues or an Empty List if none are found. This method must not return null.