com.phoenixnap.oss.ramlapisync.verification.checkers

Class ActionExistenceChecker

java.lang.Object

com.phoenixnap.oss.ramlapisync.verification.checkers.ActionExistenceChecker

All Implemented Interfaces:

RamlResourceVisitorCheck

public class ActionExistenceChecker
extends Object
implements RamlResourceVisitorCheck

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	ACTION_MISSING
protected static org.slf4j.Logger	logger Class Logger

Constructor Summary

Constructors

Constructor and Description
ActionExistenceChecker()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_MISSING

public static String ACTION_MISSING

logger

protected static final org.slf4j.Logger logger

Class Logger

Constructor Detail

ActionExistenceChecker

public ActionExistenceChecker()

Method Detail

check

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

Description copied from interface: RamlResourceVisitorCheck

Checks a particular resource

Specified by:

check in interface RamlResourceVisitorCheck

Parameters:

name - The key (relative url) of the resource being checked

reference - the Resource from the reference RAML model

target - The Resource from the target RAML model

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

maxSeverity - The maximum allowed severity of Issue that can be generated

Returns:

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