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

Packages that use RamlRoot

Package	Description
com.phoenixnap.oss.ramlapisync.data
com.phoenixnap.oss.ramlapisync.generation
com.phoenixnap.oss.ramlapisync.naming
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 RamlRoot in com.phoenixnap.oss.ramlapisync.data

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

Modifier and Type	Method and Description
RamlRoot	ApiResourceMetadata.getDocument()

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

Constructor and Description
ApiResourceMetadata(String controllerUrl, RamlResource resource, String basePackage, RamlRoot document)

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

Methods in com.phoenixnap.oss.ramlapisync.generation that return RamlRoot

Modifier and Type	Method and Description
RamlRoot	RamlGenerator.getRaml() Returns the RAML Model
static RamlRoot	RamlVerifier.loadRamlFromFile(String ramlFileUrl) Loads a RAML document from a file.
static RamlRoot	RamlParser.loadRamlFromFile(String ramlFileUrl) Loads a RAML document from a file.

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

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.
Set<ApiResourceMetadata>	RamlParser.extractControllers(RamlRoot raml) This method will extract a set of controllers from the RAML file.

Constructors in com.phoenixnap.oss.ramlapisync.generation with parameters of type RamlRoot

Constructor and Description
RamlVerifier(RamlRoot published, RamlRoot implemented, List<RamlChecker> checkers, List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers) Constructor which will accept target/implementation RAML models as well as the the checkers to be applied.
RamlVerifier(RamlRoot published, RamlRoot implemented, List<RamlChecker> checkers, List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers, List<RamlStyleChecker> styleChecks) Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify.
RamlVerifier(RamlRoot published, RamlRoot implemented, List<RamlChecker> checkers, List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers, List<RamlStyleChecker> styleChecks, String implementedUrlPrefixToIgnore) Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify.

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

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

Modifier and Type	Method and Description
static boolean	SchemaHelper.containsBodySchema(Map<String,RamlMimeType> body, RamlRoot document, boolean checkForValidSchema) Checks if a Map of mime types contains at least 1 valid JsonSchema.
static ApiBodyMetadata	SchemaHelper.mapSchemaToPojo(RamlRoot document, String schema, String basePackage, String name, String schemaLocation) Maps a JSON Schema to a JCodeModel using JSONSchema2Pojo and encapsulates it along with some metadata into an ApiBodyMetadata object.
static void	RamlHelper.mergeResources(RamlRoot raml, RamlResource resource, boolean addActions) Merges two RAML Resources trees together.
static void	RamlHelper.removeResourceTree(RamlRoot model, String urlPrefixToIgnore) Removes a section of the tree from the resources in a Raml model and moves all sub resources to the root
static String	SchemaHelper.resolveSchema(String schema, RamlRoot document) Utility method that will return a schema if the identifier is valid and exists in the raml file definition.

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

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

Modifier and Type	Method and Description
RamlRoot	RamlModelFactory.buildRamlRoot(String ramlFileUrl)
RamlRoot	RamlModelFactory.createRamlRoot()
RamlRoot	RamlModelFactory.createRamlRoot(String ramlFileUrl)

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

Modifier and Type	Method and Description
String	RamlModelEmitter.dump(RamlRoot ramlRoot)

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

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

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

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

Modifier and Type	Method and Description
RamlRoot	RJP08V1RamlModelFactory.buildRamlRoot(String ramlFileUrl)
RamlRoot	RJP08V1RamlModelFactory.createRamlRoot()
RamlRoot	RJP08V1RamlModelFactory.createRamlRoot(String ramlFileUrl)

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

Modifier and Type	Method and Description
String	RJP08V1RamlModelEmitter.dump(RamlRoot ramlRoot)

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

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

Modifier and Type	Method and Description
Pair<Set<Issue>,Set<Issue>>	RamlStyleCheckVisitorCoordinator.check(RamlRoot published, RamlRoot implemented) Performs a specific check across two Raml Models.
Set<StyleIssue>	RamlStyleCheckerAdapter.checkActionStyle(RamlActionType key, RamlAction value, IssueLocation location, RamlRoot raml)
Set<StyleIssue>	RamlStyleChecker.checkActionStyle(RamlActionType key, RamlAction value, IssueLocation location, RamlRoot raml) Check the style of a particular action
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.

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

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

Modifier and Type	Method and Description
Set<StyleIssue>	ResponseCodeDefinitionStyleChecker.checkActionStyle(RamlActionType key, RamlAction value, IssueLocation location, RamlRoot raml)
Set<StyleIssue>	ResponseBodySchemaStyleChecker.checkActionStyle(RamlActionType key, RamlAction value, IssueLocation location, RamlRoot raml)
Set<StyleIssue>	RequestBodySchemaStyleChecker.checkActionStyle(RamlActionType key, RamlAction value, IssueLocation location, RamlRoot raml)
Set<StyleIssue>	ActionSecurityResponseChecker.checkActionStyle(RamlActionType key, RamlAction value, IssueLocation location, RamlRoot raml)
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 RamlRoot in com.phoenixnap.oss.ramlapisync.verification

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

Modifier and Type	Method and Description
Pair<Set<Issue>,Set<Issue>>	RamlChecker.check(RamlRoot published, RamlRoot implemented) Performs a specific check across two Raml Models.

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

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

Modifier and Type	Method and Description
Pair<Set<Issue>,Set<Issue>>	ResourceExistenceChecker.check(RamlRoot published, RamlRoot implemented)
Pair<Set<Issue>,Set<Issue>>	RamlCheckerResourceVisitorCoordinator.check(RamlRoot published, RamlRoot implemented)