com.phoenixnap.oss.ramlapisync.generation

Class RamlParser

java.lang.Object

com.phoenixnap.oss.ramlapisync.generation.RamlParser

public class RamlParser
extends Object

Class containing methods that are used to parse raml files for code generation from the RAML

Since:

0.2.1

Author:

Kurt Paris

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	injectHttpHeadersParameter If set to true, we will add a HttpHeaders parameter in the action methods
protected static org.slf4j.Logger	logger Class Logger
protected boolean	seperateMethodsByContentType If set to true, we will generate seperate methods for different content types in the RAML

Constructor Summary

Constructors

Constructor and Description
RamlParser(String basePackage)
RamlParser(String basePackage, String startUrl)
RamlParser(String basePackage, String startUrl, boolean seperateMethodsByContentType, boolean injectHttpHeadersParameter)

Method Summary

Modifier and Type	Method and Description
Set<ApiResourceMetadata>	checkResource(String baseUrl, RamlResource resource, ApiResourceMetadata controller, RamlRoot document) Recursive method to parse resources in a Raml File.
Set<ApiResourceMetadata>	extractControllers(RamlRoot raml) This method will extract a set of controllers from the RAML file.
static RamlRoot	loadRamlFromFile(String ramlFileUrl) Loads a RAML document from a file.

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

seperateMethodsByContentType

protected boolean seperateMethodsByContentType

If set to true, we will generate seperate methods for different content types in the RAML

injectHttpHeadersParameter

protected boolean injectHttpHeadersParameter

If set to true, we will add a HttpHeaders parameter in the action methods

Constructor Detail

RamlParser

public RamlParser(String basePackage)

RamlParser

public RamlParser(String basePackage,
                  String startUrl)

RamlParser

public RamlParser(String basePackage,
                  String startUrl,
                  boolean seperateMethodsByContentType,
                  boolean injectHttpHeadersParameter)

Method Detail

extractControllers

public Set<ApiResourceMetadata> extractControllers(RamlRoot raml)

This method will extract a set of controllers from the RAML file. These controllers will contain the metadata required by the code generator, including name any annotations as well as conatining methods

Parameters:

raml - The raml document to be parsed

Returns:

A set of Controllers representing the inferred resources in the system

checkResource

public Set<ApiResourceMetadata> checkResource(String baseUrl,
                                              RamlResource resource,
                                              ApiResourceMetadata controller,
                                              RamlRoot document)

Recursive method to parse resources in a Raml File. It tries to go as deep as possible before creating the root Resource. Once this is done, methods and child resources will be relative to the root resource

Parameters:

baseUrl - The url currently being checked. Used to keep depth

resource - The Resource in the RAML file being parsed

controller - The root controller if created for this branch

document - The raml Document being parse

Returns:

A set of Controllers representing resources in this branch of the tree

loadRamlFromFile

public static RamlRoot loadRamlFromFile(String ramlFileUrl)

Loads a RAML document from a file. This method will

Parameters:

ramlFileUrl - The path to the file, this can either be a resource on the class path (in which case the classpath: prefix should be omitted) or a file on disk (in which case the file: prefix should be included)

Returns:

Built Raml model