com.phoenixnap.oss.ramlapisync.style

Class RamlStyleCheckerAdapter

java.lang.Object

com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckerAdapter

All Implemented Interfaces:

RamlStyleChecker

Direct Known Subclasses:

ActionSecurityResponseChecker, RequestBodySchemaStyleChecker, ResourceCollectionPluralisationChecker, ResourceUrlStyleChecker, ResponseBodySchemaStyleChecker, ResponseCodeDefinitionStyleChecker

public class RamlStyleCheckerAdapter
extends Object
implements RamlStyleChecker

Adapter pattern for Raml Style Checkers.

Since:

0.0.2

Author:

Kurt Paris

Constructor Summary

Constructors

Constructor and Description
RamlStyleCheckerAdapter()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

RamlStyleCheckerAdapter

public RamlStyleCheckerAdapter()

Method Detail

checkParameterStyle

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

Description copied from interface: RamlStyleChecker

Check the style of a particular parameter

Specified by:

checkParameterStyle in interface RamlStyleChecker

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

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

Description copied from interface: RamlStyleChecker

Check the style of a particular action

Specified by:

checkActionStyle in interface RamlStyleChecker

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

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

Description copied from interface: RamlStyleChecker

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

Specified by:

checkResourceStyle in interface RamlStyleChecker

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.