org.raml.v2.impl.v10.grammar

Class Raml10Grammar

java.lang.Object

org.raml.v2.grammar.BaseGrammar

org.raml.v2.impl.commons.grammar.BaseRamlGrammar

org.raml.v2.impl.v10.grammar.Raml10Grammar

public class Raml10Grammar
extends BaseRamlGrammar

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATION_TYPES_KEY_NAME

Fields inherited from class org.raml.v2.impl.commons.grammar.BaseRamlGrammar

MIME_TYPE_REGEX, RESOURCE_TYPES_KEY_NAME, SECURITY_SCHEMES_KEY_NAME, TRAITS_KEY_NAME, USES_KEY_NAME

Constructor Summary

Constructors

Constructor and Description
Raml10Grammar()

Method Summary

Methods

Modifier and Type	Method and Description
protected KeyValueRule	annotationField()
protected RegexValueRule	annotationKey()
protected Rule	annotationTypes()
protected KeyValueRule	annotationTypesField()
protected StringValueRule	annotationTypesKey()
protected AnyOfRule	arrayTypeLiteral()
protected Rule	booleanTypeLiteral()
protected AnyOfRule	dateTypeLiteral()
protected KeyValueRule	exampleFieldRule()
protected StringValueRule	extendsKey()
Rule	extension()
protected StringValueRule	fileTypeLiteral()
protected Rule	integerTypeLiteral()
Rule	library()
Rule	libraryValue()
protected KeyValueRule	mediaTypeField()
protected ObjectRule	methodValue()
protected Rule	mimeType()
protected KeyValueRule	multipleExampleFieldRule()
protected Rule	numberTypeLiteral()
protected Rule	numericTypeLiteral()
protected Rule	objectTypeLiteral()
protected KeyValueRule	optionalTitleField()
protected Rule	parameter() Describes the rule for a parameter.
protected ObjectRule	properties()
ObjectRule	raml()
protected ObjectRule	resourceValue()
protected ObjectRule	response()
protected ObjectRule	securitySchemePart()
protected StringValueRule	stringTypeLiteral()
Rule	type()
protected Rule	types()
protected KeyValueRule	typesField()
protected StringValueRule	typesKey()
protected KeyValueRule	usesField()

Methods inherited from class org.raml.v2.impl.commons.grammar.BaseRamlGrammar

anyBuiltinType, anyMethod, anyOptionalMethod, anyResourceTypeMethod, anyTypeReference, baseResourceValue, baseUriField, baseUriKey, baseUriParametersField, baseUriParametersKey, body, bodyField, bodyKey, contentField, descriptionField, descriptionKey, displayNameField, displayNameKey, documentation, documentationKey, documentations, headersField, headersKey, isField, isKey, mediaTypeKey, mimeTypeField, mimeTypeRegex, parameters, protocols, protocolsField, protocolsKey, queryParametersKey, queryStringKey, resourceField, resourceKey, resourceType, resourceTypeParamsResolved, resourceTypeReferenceField, resourceTypeRefKey, resourceTypes, resourceTypesField, resourceTypesKey, responseCodes, responseKey, responses, schemas, schemasField, schemasKey, securedByField, securedByKey, securityScheme, securitySchemes, securitySchemeSettings, securitySchemesField, securitySchemesKey, securitySchemeTypeKey, stringExcluding, titleField, titleKey, trait, traits, traitsField, traitsKey, typeKey, untitledRaml, uriParametersKey, usageField, usesKey, versionField, versionKey

Methods inherited from class org.raml.v2.grammar.BaseGrammar

allOf, any, anyOf, anyOf, anyOf, array, booleanType, exampleType, field, fieldWithRequiredValue, firstOf, floatType, integer, integerType, is, minLength, not, nullValue, numberType, objectType, objectType, optional, parentKey, range, ref, regex, requiredField, scalarType, string, stringType, when, whenChildIs, whenPresent

Methods inherited from class java.lang.Object

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

Field Detail

ANNOTATION_TYPES_KEY_NAME

public static final String ANNOTATION_TYPES_KEY_NAME

See Also:

Constant Field Values

Constructor Detail

Raml10Grammar

public Raml10Grammar()

Method Detail

raml

public ObjectRule raml()

Overrides:

raml in class BaseRamlGrammar

resourceValue

protected ObjectRule resourceValue()

Overrides:

resourceValue in class BaseRamlGrammar

methodValue

protected ObjectRule methodValue()

Overrides:

methodValue in class BaseRamlGrammar

securitySchemePart

protected ObjectRule securitySchemePart()

Overrides:

securitySchemePart in class BaseRamlGrammar

response

protected ObjectRule response()

Overrides:

response in class BaseRamlGrammar

typesField

protected KeyValueRule typesField()

typesKey

protected StringValueRule typesKey()

annotationField

protected KeyValueRule annotationField()

annotationKey

protected RegexValueRule annotationKey()

usesField

protected KeyValueRule usesField()

extension

public Rule extension()

extendsKey

protected StringValueRule extendsKey()

optionalTitleField

protected KeyValueRule optionalTitleField()

library

public Rule library()

libraryValue

public Rule libraryValue()

annotationTypesField

protected KeyValueRule annotationTypesField()

annotationTypesKey

protected StringValueRule annotationTypesKey()

annotationTypes

protected Rule annotationTypes()

types

protected Rule types()

parameter

protected Rule parameter()

Description copied from class: BaseRamlGrammar

Describes the rule for a parameter.

Specified by:

parameter in class BaseRamlGrammar

type

public Rule type()

mimeType

protected Rule mimeType()

Specified by:

mimeType in class BaseRamlGrammar

exampleFieldRule

protected KeyValueRule exampleFieldRule()

multipleExampleFieldRule

protected KeyValueRule multipleExampleFieldRule()

fileTypeLiteral

protected StringValueRule fileTypeLiteral()

numericTypeLiteral

protected Rule numericTypeLiteral()

numberTypeLiteral

protected Rule numberTypeLiteral()

integerTypeLiteral

protected Rule integerTypeLiteral()

booleanTypeLiteral

protected Rule booleanTypeLiteral()

stringTypeLiteral

protected StringValueRule stringTypeLiteral()

dateTypeLiteral

protected AnyOfRule dateTypeLiteral()

arrayTypeLiteral

protected AnyOfRule arrayTypeLiteral()

properties

protected ObjectRule properties()

objectTypeLiteral

protected Rule objectTypeLiteral()

mediaTypeField

protected KeyValueRule mediaTypeField()

Overrides:

mediaTypeField in class BaseRamlGrammar