Uses of Interface
com.phoenixnap.oss.ramlapisync.raml.RamlResource

Packages that use RamlResource

Package	Description
com.phoenixnap.oss.ramlapisync.data
com.phoenixnap.oss.ramlapisync.generation
com.phoenixnap.oss.ramlapisync.naming
com.phoenixnap.oss.ramlapisync.parser
com.phoenixnap.oss.ramlapisync.raml
com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1
com.phoenixnap.oss.ramlapisync.style
com.phoenixnap.oss.ramlapisync.style.checkers
com.phoenixnap.oss.ramlapisync.verification
com.phoenixnap.oss.ramlapisync.verification.checkers

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.data

Methods in com.phoenixnap.oss.ramlapisync.data that return RamlResource

Modifier and Type	Method and Description
RamlResource	ApiResourceMetadata.getResource()
RamlResource	ApiActionMetadata.getResource()

Methods in com.phoenixnap.oss.ramlapisync.data with parameters of type RamlResource

Modifier and Type	Method and Description
void	ApiResourceMetadata.addApiCall(RamlResource resource, RamlActionType actionType, RamlAction action)
void	ApiResourceMetadata.addApiCall(RamlResource resource, RamlActionType actionType, RamlAction action, String responseContentType, boolean injectHttpHeadersParameter)
void	ApiActionMetadata.setResource(RamlResource resource)

Constructors in com.phoenixnap.oss.ramlapisync.data with parameters of type RamlResource

Constructor and Description
ApiActionMetadata(ApiResourceMetadata parent, RamlResource resource, RamlActionType actionType, RamlAction action)
ApiActionMetadata(ApiResourceMetadata parent, RamlResource resource, RamlActionType actionType, RamlAction action, String responseContentTypeFilter, boolean injectHttpHeadersParameter)
ApiResourceMetadata(String controllerUrl, RamlResource resource, String basePackage, RamlRoot document)

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.generation

Methods in com.phoenixnap.oss.ramlapisync.generation with parameters of type RamlResource

Modifier and Type	Method and Description
Set<ApiResourceMetadata>	RamlParser.checkResource(String baseUrl, RamlResource resource, ApiResourceMetadata controller, RamlRoot document) Recursive method to parse resources in a Raml File.

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.naming

Methods in com.phoenixnap.oss.ramlapisync.naming with parameters of type RamlResource

Modifier and Type	Method and Description
static String	NamingHelper.getActionName(RamlResource controllerizedResource, RamlResource resource, RamlAction action, RamlActionType actionType) Attempts to infer the name of an action (intent) from a resource's relative URL and action details
static String	NamingHelper.getResourceName(RamlResource resource, boolean singularize) Attempts to infer the name of a resource from a resources's relative URL
static void	RamlHelper.mergeResources(RamlResource existing, RamlResource resource, boolean addActions) Tree merging algorithm, if a resource already exists it will not overwrite and add all children to the existing resource
static void	RamlHelper.mergeResources(RamlRoot raml, RamlResource resource, boolean addActions) Merges two RAML Resources trees together.

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.parser

Methods in com.phoenixnap.oss.ramlapisync.parser that return RamlResource

Modifier and Type	Method and Description
RamlResource	ResourceParser.extractResourceInfo(Class<?> clazz) Extracts class information from a (believe it or not) java class as well as the contained methods.

Methods in com.phoenixnap.oss.ramlapisync.parser with parameters of type RamlResource

Modifier and Type	Method and Description
protected void	SpringMvcResourceParser.extractAndAppendResourceInfo(Class<?> clazz, Method method, JavaDocEntry docEntry, RamlResource parentResource)
protected abstract void	ResourceParser.extractAndAppendResourceInfo(Class<?> clazz, Method method, JavaDocEntry docEntry, RamlResource parentResource) Extracts relevant info from a Java method and converts it into a RAML resource

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.raml

Methods in com.phoenixnap.oss.ramlapisync.raml that return RamlResource

Modifier and Type	Method and Description
RamlResource	RamlModelFactory.createRamlResource()
RamlResource	RamlModelFactory.createRamlResource(Object resource)
RamlResource	RamlResource.getParentResource()
RamlResource	RamlAction.getResource()
RamlResource	RamlResourceRoot.getResource(String path)

Methods in com.phoenixnap.oss.ramlapisync.raml that return types with arguments of type RamlResource

Modifier and Type	Method and Description
Map<String,RamlResource>	RamlResourceRoot.getResources()

Methods in com.phoenixnap.oss.ramlapisync.raml with parameters of type RamlResource

Modifier and Type	Method and Description
void	RamlResourceRoot.addResource(String path, RamlResource childResource)
void	RamlResource.setParentResource(RamlResource parentResource)
void	RamlAction.setResource(RamlResource resource)

Method parameters in com.phoenixnap.oss.ramlapisync.raml with type arguments of type RamlResource

Modifier and Type	Method and Description
void	RamlResourceRoot.addResources(Map<String,RamlResource> resources)

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1

Classes in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1 that implement RamlResource

Modifier and Type	Class and Description
class	RJP08V1RamlResource Implementation based on the Raml 0.8 Parser

Methods in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1 that return RamlResource

Modifier and Type	Method and Description
RamlResource	RJP08V1RamlModelFactory.createRamlResource()
RamlResource	RJP08V1RamlModelFactory.createRamlResource(Object resource)
RamlResource	RJP08V1RamlResource.getParentResource()
RamlResource	RJP08V1RamlAction.getResource()
RamlResource	RJP08V1RamlRoot.getResource(String path)
RamlResource	RJP08V1RamlResource.getResource(String path)

Methods in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1 that return types with arguments of type RamlResource

Modifier and Type	Method and Description
Map<String,RamlResource>	RJP08V1RamlRoot.getResources()
Map<String,RamlResource>	RJP08V1RamlResource.getResources()

Methods in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1 with parameters of type RamlResource

Modifier and Type	Method and Description
void	RJP08V1RamlRoot.addResource(String path, RamlResource childResource)
void	RJP08V1RamlResource.addResource(String path, RamlResource childResource)
void	RJP08V1RamlResource.setParentResource(RamlResource parentResource)
void	RJP08V1RamlAction.setResource(RamlResource resource)

Method parameters in com.phoenixnap.oss.ramlapisync.raml.rjp.raml08v1 with type arguments of type RamlResource

Modifier and Type	Method and Description
void	RJP08V1RamlRoot.addResources(Map<String,RamlResource> resources)
void	RJP08V1RamlResource.addResources(Map<String,RamlResource> resources)

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.style

Methods in com.phoenixnap.oss.ramlapisync.style with parameters of type RamlResource

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

Constructors in com.phoenixnap.oss.ramlapisync.style with parameters of type RamlResource

Constructor and Description
StyleIssue(IssueLocation location, String description, RamlResource resource, RamlAction action)

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.style.checkers

Methods in com.phoenixnap.oss.ramlapisync.style.checkers with parameters of type RamlResource

Modifier and Type	Method and Description
Set<StyleIssue>	ResourceUrlStyleChecker.checkResourceStyle(String name, RamlResource resource, IssueLocation location, RamlRoot raml)
Set<StyleIssue>	ResourceCollectionPluralisationChecker.checkResourceStyle(String name, RamlResource resource, IssueLocation location, RamlRoot raml)

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.verification

Methods in com.phoenixnap.oss.ramlapisync.verification that return RamlResource

Modifier and Type	Method and Description
RamlResource	Issue.getResourceLocation()

Methods in com.phoenixnap.oss.ramlapisync.verification with parameters of type RamlResource

Modifier and Type	Method and Description
static String	Issue.buildRamlLocation(RamlResource resource, RamlAction action, String parameter) Uniform way of identifying a location in the Raml file based on the Resource and Action
Pair<Set<Issue>,Set<Issue>>	RamlResourceVisitorCheck.check(String name, RamlResource reference, RamlResource target, IssueLocation location, IssueSeverity maxSeverity) Checks a particular resource

Constructors in com.phoenixnap.oss.ramlapisync.verification with parameters of type RamlResource

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)

Uses of RamlResource in com.phoenixnap.oss.ramlapisync.verification.checkers

Methods in com.phoenixnap.oss.ramlapisync.verification.checkers with parameters of type RamlResource

Modifier and Type	Method and Description
Pair<Set<Issue>,Set<Issue>>	ActionExistenceChecker.check(String name, RamlResource reference, RamlResource target, IssueLocation location, IssueSeverity maxSeverity)