com.phoenixnap.oss.ramlapisync.generation

Class RamlGenerator

java.lang.Object

com.phoenixnap.oss.ramlapisync.generation.RamlGenerator

public class RamlGenerator
extends Object

Class containing RAML generation driver. Methods in this class are used to orchestrate the process of extracting information from classes, generating RAML and storing this as a String or in a File.

Since:

0.0.1

Author:

Kurt Paris

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RamlGenerator() Default constructor.
RamlGenerator(ResourceParser scanner)

Method Summary

Modifier and Type	Method and Description
protected List<RamlDocumentationItem>	generateDocuments(Set<ApiDocumentMetadata> documents) Parses the list of document models and adds them as RAML documentItem nodes in the RAML document.
RamlGenerator	generateRamlForClasses(String title, String version, String baseUri, Class<?>[] classesToGenerate, Set<ApiDocumentMetadata> documents) Parses classes array supplied and builds a Raml Model from any request mappings defined inside
RamlRoot	getRaml() Returns the RAML Model
File	getRamlOutputFile(String path) Takes the absolute path and gets the Raml file to be created
File	outputRamlToFile(String path, Boolean createPathIfMissing, Boolean removeOldOutput) Emits the RAML model into its string representation and saves it as a file in the specified path
String	outputRamlToString() Emits the RAML model into its string representation
protected String	postProcessRaml(String preRaml) Raml post-processor that will be run before the final RAML string is output to overcome a limitation due to character escaping.
void	setRamlMediaType(String mediaType) Adds a global media type to the document

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

Constructor Detail

RamlGenerator

public RamlGenerator()

Default constructor. A scanner is not mandatory.

RamlGenerator

public RamlGenerator(ResourceParser scanner)

Parameters:

scanner - The resource parsing engine. Only required for RAML generation

Method Detail

setRamlMediaType

public void setRamlMediaType(String mediaType)

Adds a global media type to the document

Parameters:

mediaType - The default media type

generateRamlForClasses

public RamlGenerator generateRamlForClasses(String title,
                                            String version,
                                            String baseUri,
                                            Class<?>[] classesToGenerate,
                                            Set<ApiDocumentMetadata> documents)

Parses classes array supplied and builds a Raml Model from any request mappings defined inside

Parameters:

title - Document Title

version - Version of the Api

baseUri - Base uri of the api at runtime

classesToGenerate - List of classes to parse

documents - A set of documents to be included

Returns:

This object for chaining

generateDocuments

protected List<RamlDocumentationItem> generateDocuments(Set<ApiDocumentMetadata> documents)

Parses the list of document models and adds them as RAML documentItem nodes in the RAML document.

Parameters:

documents - A set of metadata identifying the documents to be included

Returns:

A List of RAML document items containing the supplied documents

postProcessRaml

protected String postProcessRaml(String preRaml)

Raml post-processor that will be run before the final RAML string is output to overcome a limitation due to character escaping.

Parameters:

preRaml - The raw RAML as a string before processing has been applied

Returns:

The RAML document as a String after post processing has been applied

outputRamlToString

public String outputRamlToString()

Emits the RAML model into its string representation

Returns:

The RAML document as a String

outputRamlToFile

public File outputRamlToFile(String path,
                             Boolean createPathIfMissing,
                             Boolean removeOldOutput)
                      throws FileNotFoundException

Emits the RAML model into its string representation and saves it as a file in the specified path

Parameters:

path - The path to which the RAML document will be saved

createPathIfMissing - Indicates if the path and/or file should be created if it doesn't exist

removeOldOutput - Indicates if we will empty the output directory before generation occurs

Returns:

A file handle to the created document file

Throws:

FileNotFoundException - if the supplied path does not exist

getRamlOutputFile

public File getRamlOutputFile(String path)

Takes the absolute path and gets the Raml file to be created

Parameters:

path - The path for the raml file to be saved in

Returns:

raml file to be generated

getRaml

public RamlRoot getRaml()

Returns the RAML Model

Returns:

the RAML model