com.phoenixnap.oss.ramlapisync.verification

Interface RamlResourceVisitorCheck

All Known Implementing Classes:

ActionExistenceChecker

public interface RamlResourceVisitorCheck

A visitor that will be invoked when an resource is identified

Since:

0.0.2

Author:

Kurt Paris

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

Method Detail

check

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

Checks a particular resource

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.