Raml (Generator 1.3.3 API)

java.lang.Object
- org.raml.model.Raml

Direct Known Subclasses:

Raml2
```
public class Raml
extends Object
```
Raml class.

Version:

$Id: $Id

Author:

kor

Field Summary

Fields
Modifier and Type Field and Description

protected List<Map<String,String>> schemas

Fields
Modifier and Type	Field and Description
`protected List<Map<String,String>>`	`schemas`

Constructor Summary

Constructors
Constructor and Description

Raml()
Constructor for Raml.

Constructors
Constructor and Description
`Raml()` Constructor for Raml.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBasePath()` getBasePath.
`String`	`getBaseUri()` Getter for the field `baseUri`.
`Map<String,UriParameter>`	`getBaseUriParameters()` Getter for the field `baseUriParameters`.
`Map<String,String>`	`getConsolidatedSchemas()` getConsolidatedSchemas.
`List<DocumentationItem>`	`getDocumentation()` Getter for the field `documentation`.
`String`	`getMediaType()` Getter for the field `mediaType`.
`List<Protocol>`	`getProtocols()` Getter for the field `protocols`.
`Resource`	`getResource(String path)` getResource.
`Map<String,Resource>`	`getResources()` Getter for the field `resources`.
`List<Map<String,Template>>`	`getResourceTypes()` Getter for the field `resourceTypes`.
`List<Map<String,String>>`	`getSchemas()` Getter for the field `schemas`.
`List<SecurityReference>`	`getSecuredBy()` Getter for the field `securedBy`.
`List<Map<String,SecurityScheme>>`	`getSecuritySchemes()` Getter for the field `securitySchemes`.
`String`	`getTitle()` Getter for the field `title`.
`List<Map<String,Template>>`	`getTraits()` Getter for the field `traits`.
`String`	`getUri()` getUri.
`String`	`getVersion()` Getter for the field `version`.
`void`	`setBaseUri(String baseUri)` Setter for the field `baseUri`.
`void`	`setBaseUriParameters(Map<String,UriParameter> uriParameters)` Setter for the field `baseUriParameters`.
`void`	`setDocumentation(List<DocumentationItem> documentation)` Setter for the field `documentation`.
`void`	`setMediaType(String mediaType)` Setter for the field `mediaType`.
`void`	`setProtocols(List<Protocol> protocols)` Setter for the field `protocols`.
`void`	`setResources(Map<String,Resource> resources)` Setter for the field `resources`.
`void`	`setResourceTypes(List<Map<String,Template>> resourceTypes)` Setter for the field `resourceTypes`.
`void`	`setSchemas(List<Map<String,String>> schemas)` Setter for the field `schemas`.
`void`	`setSecuredBy(List<SecurityReference> securedBy)` Setter for the field `securedBy`.
`void`	`setSecuritySchemes(List<Map<String,SecurityScheme>> securitySchemes)` Setter for the field `securitySchemes`.
`void`	`setTitle(String title)` Setter for the field `title`.
`void`	`setTraits(List<Map<String,Template>> traits)` Setter for the field `traits`.
`void`	`setVersion(String version)` Setter for the field `version`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - schemas
```
protected List<Map<String,String>> schemas
```
- Constructor Detail
  - Raml
```
public Raml()
```
    Constructor for Raml.
- Method Detail
  - setDocumentation
```
public void setDocumentation(List<DocumentationItem> documentation)
```
    Setter for the field documentation.
    
    Parameters:
    
    documentation - a List object.
  - getDocumentation
```
public List<DocumentationItem> getDocumentation()
```
    Getter for the field documentation.
    
    Returns:
    
    a List object.
  - setBaseUriParameters
```
public void setBaseUriParameters(Map<String,UriParameter> uriParameters)
```
    Setter for the field baseUriParameters.
    
    Parameters:
    
    uriParameters - a Map object.
  - setResources
```
public void setResources(Map<String,Resource> resources)
```
    Setter for the field resources.
    
    Parameters:
    
    resources - a Map object.
  - getTitle
```
public String getTitle()
```
    Getter for the field title.
    
    Returns:
    
    a String object.
  - setTitle
```
public void setTitle(String title)
```
    Setter for the field title.
    
    Parameters:
    
    title - a String object.
  - getVersion
```
public String getVersion()
```
    Getter for the field version.
    
    Returns:
    
    a String object.
  - setVersion
```
public void setVersion(String version)
```
    Setter for the field version.
    
    Parameters:
    
    version - a String object.
  - getBaseUri
```
public String getBaseUri()
```
    Getter for the field baseUri.
    
    Returns:
    
    a String object.
  - setBaseUri
```
public void setBaseUri(String baseUri)
```
    Setter for the field baseUri.
    
    Parameters:
    
    baseUri - a String object.
  - getBasePath
```
public String getBasePath()
```
    getBasePath.
    
    Returns:
    
    a String object.
  - getUri
```
public String getUri()
```
    getUri.
    
    Returns:
    
    a String object.
  - getMediaType
```
public String getMediaType()
```
    Getter for the field mediaType.
    
    Returns:
    
    a String object.
  - setMediaType
```
public void setMediaType(String mediaType)
```
    Setter for the field mediaType.
    
    Parameters:
    
    mediaType - a String object.
  - getResources
```
public Map<String,Resource> getResources()
```
    Getter for the field resources.
    
    Returns:
    
    a Map object.
  - getBaseUriParameters
```
public Map<String,UriParameter> getBaseUriParameters()
```
    Getter for the field baseUriParameters.
    
    Returns:
    
    a Map object.
  - getResourceTypes
```
public List<Map<String,Template>> getResourceTypes()
```
    Getter for the field resourceTypes.
    
    Returns:
    
    a List object.
  - setResourceTypes
```
public void setResourceTypes(List<Map<String,Template>> resourceTypes)
```
    Setter for the field resourceTypes.
    
    Parameters:
    
    resourceTypes - a List object.
  - getTraits
```
public List<Map<String,Template>> getTraits()
```
    Getter for the field traits.
    
    Returns:
    
    a List object.
  - setTraits
```
public void setTraits(List<Map<String,Template>> traits)
```
    Setter for the field traits.
    
    Parameters:
    
    traits - a List object.
  - getSchemas
```
public List<Map<String,String>> getSchemas()
```
    Getter for the field schemas.
    
    Returns:
    
    a List object.
  - setSchemas
```
public void setSchemas(List<Map<String,String>> schemas)
```
    Setter for the field schemas.
    
    Parameters:
    
    schemas - a List object.
  - getProtocols
```
public List<Protocol> getProtocols()
```
    Getter for the field protocols.
    
    Returns:
    
    a List object.
  - setProtocols
```
public void setProtocols(List<Protocol> protocols)
```
    Setter for the field protocols.
    
    Parameters:
    
    protocols - a List object.
  - getSecuritySchemes
```
public List<Map<String,SecurityScheme>> getSecuritySchemes()
```
    Getter for the field securitySchemes.
    
    Returns:
    
    a List object.
  - setSecuritySchemes
```
public void setSecuritySchemes(List<Map<String,SecurityScheme>> securitySchemes)
```
    Setter for the field securitySchemes.
    
    Parameters:
    
    securitySchemes - a List object.
  - getSecuredBy
```
public List<SecurityReference> getSecuredBy()
```
    Getter for the field securedBy.
    
    Returns:
    
    a List object.
  - setSecuredBy
```
public void setSecuredBy(List<SecurityReference> securedBy)
```
    Setter for the field securedBy.
    
    Parameters:
    
    securedBy - a List object.
  - getConsolidatedSchemas
```
public Map<String,String> getConsolidatedSchemas()
```
    getConsolidatedSchemas.
    
    Returns:
    
    a Map object.
  - getResource
```
public Resource getResource(String path)
```
    getResource.
    
    Parameters:
    
    path - a String object.
    
    Returns:
    
    a Resource object.

Class Raml

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

schemas

Constructor Detail

Raml

Method Detail

setDocumentation

getDocumentation

setBaseUriParameters

setResources

getTitle

setTitle

getVersion

setVersion

getBaseUri

setBaseUri

getBasePath

getUri

getMediaType

setMediaType

getResources

getBaseUriParameters

getResourceTypes

setResourceTypes

getTraits

setTraits

getSchemas

setSchemas

getProtocols

setProtocols

getSecuritySchemes

setSecuritySchemes

getSecuredBy

setSecuredBy

getConsolidatedSchemas

getResource