org.jooby.apitool.raml

Class Raml

java.lang.Object

org.jooby.apitool.raml.Raml

public class Raml
extends Object

RAML objects for describing a RAML definition file. This is a partial representation of the RAML specification.

Since:

1.2.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Raml()

Method Summary

Modifier and Type	Method and Description
static Raml	build(Raml base, List<RouteMethod> routes) Build a Raml object from list of RouteMethod.
RamlType	define(Type type) Register a Java type and produces an equivalent RAML type.
RamlType	define(Type javaType, RamlType baseType) Define/map a custom Java type to RAML type.
String	getBaseUri() RAML base uri.
List<String>	getMediaType() Get media types.
List<String>	getProtocols() Get protocols.
Map<String,RamlPath>	getResources() Get resources.
String	getTitle() RAML title.
Map<String,RamlType>	getTypes() RAML types.
String	getVersion() RAML version.
RamlPath	path(String pattern) Get a path for the given pattern.
void	setBaseUri(String baseUri) Set base uri.
void	setMediaType(List<String> mediaType) Set media types.
void	setProtocols(List<String> protocols) Set protocols.
void	setResources(Map<String,RamlPath> resources) Set RAML paths.
void	setTitle(String title) Set RAML title.
void	setVersion(String version) Set RAML version.
String	toYaml() Convert this RAML object to Yaml.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Raml

public Raml()

Method Detail

getTitle

public String getTitle()

RAML title.

Returns:

RAML title.

setTitle

public void setTitle(String title)

Set RAML title.

Parameters:

title - RAML title.

getVersion

public String getVersion()

RAML version.

Returns:

RAML version.

setVersion

public void setVersion(String version)

Set RAML version.

Parameters:

version - RAML version.

getBaseUri

public String getBaseUri()

RAML base uri.

Returns:

RAML base uri.

setBaseUri

public void setBaseUri(String baseUri)

Set base uri.

Parameters:

baseUri - Base uri.

getMediaType

public List<String> getMediaType()

Get media types.

Returns:

Media types.

setMediaType

public void setMediaType(List<String> mediaType)

Set media types.

Parameters:

mediaType - Media types.

getProtocols

public List<String> getProtocols()

Get protocols.

Returns:

Protocols.

setProtocols

public void setProtocols(List<String> protocols)

Set protocols.

Parameters:

protocols - Protocols.

getTypes

public Map<String,RamlType> getTypes()

RAML types.

Returns:

RAML types.

getResources

public Map<String,RamlPath> getResources()

Get resources.

Returns:

Resources.

path

public RamlPath path(String pattern)

Get a path for the given pattern. If the path doesn't exist, a new path will be created.

Parameters:

pattern - Pattern.

Returns:

Path for the given pattern.

define

public RamlType define(Type javaType,
                       RamlType baseType)

Define/map a custom Java type to RAML type.

   RamlType uuid = raml.define(UUID.class, RamlType.STRING);
   uuid.setPattern("...");
 

Parameters:

javaType - Java type.

baseType - RAML base type.

Returns:

New RAML type.

define

public RamlType define(Type type)

Register a Java type and produces an equivalent RAML type. It returns an existing RAML type if the Java type was registered already.

Parameters:

type - Java type.

Returns:

RAML type.

setResources

public void setResources(Map<String,RamlPath> resources)

Set RAML paths.

Parameters:

resources - RAML paths.

toYaml

public String toYaml()
              throws IOException

Convert this RAML object to Yaml.

Returns:

Yaml string.

Throws:

IOException - If something goes wrong.

build

public static Raml build(Raml base,
                         List<RouteMethod> routes)

Build a Raml object from list of RouteMethod.

Parameters:

base - Base raml (might be null).

routes - List of routes.

Returns:

RAML object.