com.phoenixnap.oss.ramlapisync.verification.checkers

Class RamlCheckerResourceVisitorCoordinator

java.lang.Object

com.phoenixnap.oss.ramlapisync.verification.checkers.RamlCheckerResourceVisitorCoordinator

All Implemented Interfaces:

RamlChecker

public class RamlCheckerResourceVisitorCoordinator
extends Object
implements RamlChecker

Raml checker that cross checks Resources between 2 RAML models. Only directly corresponding resources will be parsed

Since:

0.0.2

Author:

Kurt Paris

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RamlCheckerResourceVisitorCoordinator(List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers)

Method Summary

Modifier and Type	Method and Description
static void	addIssue(Set<Issue> errors, Set<Issue> warnings, Issue issue, String logDescription) Adds an issue to the respective set according to issue severity and logs at the appropriate log level
Pair<Set<Issue>,Set<Issue>>	check(RamlRoot published, RamlRoot implemented) Performs a specific check across two Raml Models.

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

Constructor Detail

RamlCheckerResourceVisitorCoordinator

public RamlCheckerResourceVisitorCoordinator(List<RamlActionVisitorCheck> actionCheckers,
                                             List<RamlResourceVisitorCheck> resourceCheckers)

Method Detail

addIssue

public static void addIssue(Set<Issue> errors,
                            Set<Issue> warnings,
                            Issue issue,
                            String logDescription)

Adds an issue to the respective set according to issue severity and logs at the appropriate log level

Parameters:

errors - Set of Errors to add to

warnings - Set of Warnings to add to

issue - The issue to be added

logDescription - The string to be logged

check

public Pair<Set<Issue>,Set<Issue>> check(RamlRoot published,
                                         RamlRoot implemented)

Description copied from interface: RamlChecker

Performs a specific check across two Raml Models.

Specified by:

check in interface RamlChecker

Parameters:

published - The Raml as published in the contract

implemented - The Raml as generated from the implementation

Returns:

A pair containing a set of Warnings and Errors (as first and second respectively)