org.raml.v2.api

Class RamlModelResult

java.lang.Object

org.raml.v2.api.RamlModelResult

public class RamlModelResult
extends Object

Represents the result of parsing a top level RAML descriptor. If there are no parsing errors, the Api model matching the RAML version is available. If there are parsing errors, the list of errors is available.

Method Summary

Methods

Modifier and Type	Method and Description
Api	getApiV08()
Api	getApiV10()
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

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

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