com.phoenixnap.oss.ramlapisync.style.checkers

Class ResponseBodySchemaStyleChecker

java.lang.Object

com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckerAdapter

com.phoenixnap.oss.ramlapisync.style.checkers.ResponseBodySchemaStyleChecker

All Implemented Interfaces:

RamlStyleChecker

public class ResponseBodySchemaStyleChecker
extends RamlStyleCheckerAdapter

Style checker that will check for existance of valid schemas in request bodies

Since:

0.5.2

Author:

kurtpa

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION
protected static org.slf4j.Logger	logger Class Logger

Constructor Summary

Constructors

Constructor and Description
ResponseBodySchemaStyleChecker(String actionTypesToCheck)

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

Methods inherited from class com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckerAdapter

checkParameterStyle, checkResourceStyle

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Class Logger

DESCRIPTION

public static String DESCRIPTION

Constructor Detail

ResponseBodySchemaStyleChecker

public ResponseBodySchemaStyleChecker(String actionTypesToCheck)

Method Detail

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

Overrides:

checkActionStyle in class RamlStyleCheckerAdapter

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.