com.phoenixnap.oss.ramlapisync.verification.checkers

Class ActionQueryParameterChecker

java.lang.Object

com.phoenixnap.oss.ramlapisync.verification.checkers.ActionQueryParameterChecker

All Implemented Interfaces:

RamlActionVisitorCheck

public class ActionQueryParameterChecker
extends Object
implements RamlActionVisitorCheck

A visitor that will be invoked when an action is identified

Since:

0.0.2

Author:

Kurt Paris

Field Summary

Fields

Modifier and Type	Field and Description
static String	INCOMPATIBLE_TYPES
static String	INCOMPATIBLE_VALIDATION
protected static org.slf4j.Logger	logger Class Logger
static String	QUERY_PARAMETER_FOUND_IN_FORM
static String	QUERY_PARAMETER_MISSING
static String	REQUIRED_PARAM_HIDDEN

Constructor Summary

Constructors

Constructor and Description
ActionQueryParameterChecker()

Method Summary

Modifier and Type	Method and Description
Pair<Set<Issue>,Set<Issue>>	check(RamlActionType name, RamlAction reference, RamlAction target, IssueLocation location, IssueSeverity maxSeverity) Checks a particular action

Methods inherited from class java.lang.Object

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

Field Detail

QUERY_PARAMETER_MISSING

public static String QUERY_PARAMETER_MISSING

QUERY_PARAMETER_FOUND_IN_FORM

public static String QUERY_PARAMETER_FOUND_IN_FORM

INCOMPATIBLE_TYPES

public static String INCOMPATIBLE_TYPES

INCOMPATIBLE_VALIDATION

public static String INCOMPATIBLE_VALIDATION

REQUIRED_PARAM_HIDDEN

public static String REQUIRED_PARAM_HIDDEN

logger

protected static final org.slf4j.Logger logger

Class Logger

Constructor Detail

ActionQueryParameterChecker

public ActionQueryParameterChecker()

Method Detail

check

public Pair<Set<Issue>,Set<Issue>> check(RamlActionType name,
                                         RamlAction reference,
                                         RamlAction target,
                                         IssueLocation location,
                                         IssueSeverity maxSeverity)

Description copied from interface: RamlActionVisitorCheck

Checks a particular action

Specified by:

check in interface RamlActionVisitorCheck

Parameters:

name - The key/verb of the action

reference - The Action which is the source of truth from the RAML model

target - The target Action to check against from the RAML model

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

maxSeverity - The maximum severity that can be applied to any errors

Returns:

A pair containing a set of Warnings and Errors (as first and second respectively). This method must not return null.