com.phoenixnap.oss.ramlapisync.style

Class RamlStyleCheckVisitorCoordinator

java.lang.Object

com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckVisitorCoordinator

All Implemented Interfaces:

RamlChecker

public class RamlStyleCheckVisitorCoordinator
extends Object
implements RamlChecker

Provides a Vistor pattern approach to Style Checks. Iterates through the model and invokes callbacks on specific checkers.

Since:

0.0.2

Author:

Kurt Paris

Constructor Summary

Constructors

Constructor and Description
RamlStyleCheckVisitorCoordinator(List<RamlStyleChecker> styleChecks)

Method Summary

Modifier and Type	Method and Description
protected void	addIssue(IssueLocation location, String description, String ramlLocation)
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

Constructor Detail

RamlStyleCheckVisitorCoordinator

public RamlStyleCheckVisitorCoordinator(List<RamlStyleChecker> styleChecks)

Method Detail

check

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

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 list of Warnings and an empty list of Errors (as first and second respectively)

addIssue

protected final void addIssue(IssueLocation location,
                              String description,
                              String ramlLocation)