com.phoenixnap.oss.ramlapisync.style.checkers

Class ResourceUrlStyleChecker

java.lang.Object

com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckerAdapter

com.phoenixnap.oss.ramlapisync.style.checkers.ResourceUrlStyleChecker

All Implemented Interfaces:

RamlStyleChecker

public class ResourceUrlStyleChecker
extends RamlStyleCheckerAdapter

Style checker that ensures that certain characters are not used in resource URLs

Since:

0.0.2

Author:

Kurt Paris

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ResourceUrlStyleChecker()

Method Summary

Modifier and Type	Method and Description
Set<StyleIssue>	checkResourceStyle(String name, RamlResource resource, IssueLocation location, RamlRoot raml) Check the style of a particular resource.

Methods inherited from class com.phoenixnap.oss.ramlapisync.style.RamlStyleCheckerAdapter

checkActionStyle, checkParameterStyle

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

SPECIAL_CHARS_IN_URL

public static String SPECIAL_CHARS_IN_URL

CAPITALISED_RESOURCE

public static String CAPITALISED_RESOURCE

Constructor Detail

ResourceUrlStyleChecker

public ResourceUrlStyleChecker()

Method Detail

checkResourceStyle

public Set<StyleIssue> checkResourceStyle(String name,
                                          RamlResource resource,
                                          IssueLocation location,
                                          RamlRoot raml)

Description copied from interface: RamlStyleChecker

Check the style of a particular resource. This will be called on all child resources by the coordinator.

Specified by:

checkResourceStyle in interface RamlStyleChecker

Overrides:

checkResourceStyle in class RamlStyleCheckerAdapter

Parameters:

name - The name of the resource (relative URL)

resource - The Resource from the RAML model

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

raml - The Raml Document being checked

Returns:

A list of style issues or an Empty List if none are found. This method must not return null.