com.phoenixnap.oss.ramlapisync.verification

Class Issue

java.lang.Object

com.phoenixnap.oss.ramlapisync.verification.Issue

Direct Known Subclasses:

StyleIssue

public class Issue
extends Object

Data object which identifies a discrepancy between two RAML models

Since:

0.0.2

Author:

Kurt Paris

Constructor Summary

Constructors

Constructor and Description
Issue(IssueSeverity severity, IssueLocation location, IssueType type, String description, RamlResource resource, RamlAction action)
Issue(IssueSeverity severity, IssueLocation location, IssueType type, String description, RamlResource resource, RamlAction action, String parameter)
Issue(IssueSeverity severity, IssueLocation location, IssueType type, String description, String ramlLocation)

Method Summary

Modifier and Type	Method and Description
static String	buildRamlLocation(RamlResource resource, RamlAction action, String parameter) Uniform way of identifying a location in the Raml file based on the Resource and Action
boolean	equals(Object obj)
RamlAction	getAction()
String	getDescription()
IssueLocation	getLocation()
String	getRamlLocation() Gets the location of the Issue as a string, or builds it from the Resource/Action/Parameter info stored.
RamlResource	getResourceLocation()
IssueSeverity	getSeverity()
IssueType	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Issue

public Issue(IssueSeverity severity,
             IssueLocation location,
             IssueType type,
             String description,
             RamlResource resource,
             RamlAction action,
             String parameter)

Issue

public Issue(IssueSeverity severity,
             IssueLocation location,
             IssueType type,
             String description,
             RamlResource resource,
             RamlAction action)

Issue

public Issue(IssueSeverity severity,
             IssueLocation location,
             IssueType type,
             String description,
             String ramlLocation)

Method Detail

buildRamlLocation

public static String buildRamlLocation(RamlResource resource,
                                       RamlAction action,
                                       String parameter)

Uniform way of identifying a location in the Raml file based on the Resource and Action

Parameters:

resource - The Resource that this Issue relates to

action - The Action that this Issue relates to

parameter - The parameter name that this Issue Relates to

Returns:

String identifying the location of this issue

getType

public IssueType getType()

getSeverity

public IssueSeverity getSeverity()

getLocation

public IssueLocation getLocation()

getDescription

public String getDescription()

getRamlLocation

public String getRamlLocation()

Gets the location of the Issue as a string, or builds it from the Resource/Action/Parameter info stored.

Returns:

The location as a string

getResourceLocation

public RamlResource getResourceLocation()

getAction

public RamlAction getAction()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object