RamlModelResult (Raml Java Parser 2nd generation 1.0.51 API)

java.lang.Object
- org.raml.v2.api.RamlModelResult

```
public class RamlModelResult
extends Object
```
Represents the result of parsing a top level RAML descriptor or fragment. If there are no parsing errors and the parsed RAML was a top level descriptor, the Api model matching the RAML version is available. If the parsed raml is 1.0 fragment and there are no errors, the corresponding fragment instance is available. If there are parsing errors, the list of errors is available.

Constructor Summary

Constructors
Constructor and Description
`RamlModelResult(DocumentationItem documentationItem)`
`RamlModelResult(ExampleSpec exampleSpec)`
`RamlModelResult(ResourceType resourceType)`
`RamlModelResult(SecurityScheme securityScheme)`
`RamlModelResult(Trait trait)`
`RamlModelResult(TypeDeclaration typeDeclaration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Api`	`getApiV08()`
`Api`	`getApiV10()`
`DocumentationItem`	`getDocumentationItem()`
`ExampleSpec`	`getExampleSpec()`
`RamlFragment`	`getFragment()`
`Library`	`getLibrary()`
`ResourceType`	`getResourceType()`
`SecurityScheme`	`getSecurityScheme()`
`Trait`	`getTrait()`
`TypeDeclaration`	`getTypeDeclaration()`
`List<ValidationResult>`	`getValidationResults()`
`boolean`	`hasErrors()`
`boolean`	`isVersion08()`
`boolean`	`isVersion10()`

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

- Constructor Detail
  - RamlModelResult
```
public RamlModelResult(TypeDeclaration typeDeclaration)
```
  - RamlModelResult
```
public RamlModelResult(SecurityScheme securityScheme)
```
  - RamlModelResult
```
public RamlModelResult(DocumentationItem documentationItem)
```
  - RamlModelResult
```
public RamlModelResult(Trait trait)
```
  - RamlModelResult
```
public RamlModelResult(ResourceType resourceType)
```
  - RamlModelResult
```
public RamlModelResult(ExampleSpec exampleSpec)
```
- Method Detail
  - hasErrors
```
public boolean hasErrors()
```
    Returns:
    
    true if any parsing error occurred
  - isVersion10
```
public boolean isVersion10()
```
    Returns:
    
    true if a RAML 1.0 descriptor was parsed and there were no errors
  - isVersion08
```
public boolean isVersion08()
```
    Returns:
    
    true if a RAML 0.8 descriptor was parsed and there were no errors
  - getValidationResults
```
@Nonnull
public List<ValidationResult> getValidationResults()
```
    Returns:
    
    the list of validation results if there were parsing errors or an empty list if there were no parsing errors
  - getApiV10
```
@Nullable
public Api getApiV10()
```
    Returns:
    
    the RAML Api v1.0 parsed without errors or null if there were errors or the RAML version is not 1.0 or is not a top level RAML
  - getApiV08
```
@Nullable
public Api getApiV08()
```
    Returns:
    
    the RAML Api v0.8 parsed without errors or null if there were errors or the RAML version is not 0.8
  - getLibrary
```
@Nullable
public Library getLibrary()
```
    Returns:
    
    the RAML Library v1.0 parsed without errors or null if there were errors or the RAML is not a Library fragment
  - getTypeDeclaration
```
@Nullable
public TypeDeclaration getTypeDeclaration()
```
    Returns:
    
    the RAML Data Type v1.0 parsed without errors or null if there were errors or the RAML is not a Data Type fragment
  - getSecurityScheme
```
@Nullable
public SecurityScheme getSecurityScheme()
```
    Returns:
    
    the RAML Security Scheme v1.0 parsed without errors or null if there were errors or the RAML is not a Security Scheme fragment
  - getTrait
```
@Nullable
public Trait getTrait()
```
    Returns:
    
    the RAML Trait v1.0 parsed without errors or null if there were errors or the RAML is not a Trait fragment
  - getResourceType
```
@Nullable
public ResourceType getResourceType()
```
    Returns:
    
    the RAML ResourceType v1.0 parsed without errors or null if there were errors or the RAML is not a ResourceType fragment
  - getExampleSpec
```
@Nullable
public ExampleSpec getExampleSpec()
```
    Returns:
    
    the RAML NamedExample v1.0 parsed without errors or null if there were errors or the RAML is not a NamedExample fragment
  - getDocumentationItem
```
@Nullable
public DocumentationItem getDocumentationItem()
```
    Returns:
    
    the RAML DocumentationItem v1.0 parsed without errors or null if there were errors or the RAML is not a DocumentationItem fragment
  - getFragment
```
@Nullable
public RamlFragment getFragment()
```
    Returns:
    
    the RAML 1.0 fragment identifier or null if the RAML has errors or is version 0.8

Class RamlModelResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RamlModelResult

RamlModelResult

RamlModelResult

RamlModelResult

RamlModelResult

RamlModelResult

Method Detail

hasErrors

isVersion10

isVersion08

getValidationResults

getApiV10

getApiV08

getLibrary

getTypeDeclaration

getSecurityScheme

getTrait

getResourceType

getExampleSpec

getDocumentationItem

getFragment