BaseRamlGrammar (Raml Java Parser 2nd generation 1.0.51 API)

java.lang.Object
- org.raml.yagi.framework.grammar.BaseGrammar
- - org.raml.v2.internal.impl.commons.grammar.BaseRamlGrammar

Direct Known Subclasses:: Raml08Grammar, Raml10Grammar

public abstract class BaseRamlGrammar
extends BaseGrammar

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MIME_TYPE_REGEX`
`static String`	`OAUTH_1_0`
`static String`	`OAUTH_2_0`
`static String`	`QUERY_PARAMETERS_KEY_NAME`
`static String`	`QUERY_STRING_KEY_NAME`
`static String`	`RESOURCE_TYPES_KEY_NAME`
`static String`	`SCHEMAS_KEY_NAME`
`static String`	`SECURITY_SCHEMES_KEY_NAME`
`static String`	`TRAITS_KEY_NAME`
`static String`	`TYPES_KEY_NAME`
`static String`	`USES_KEY_NAME`

Constructor Summary

Constructors
Constructor and Description

BaseRamlGrammar()

Constructors
Constructor and Description
`BaseRamlGrammar()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected AnyOfRule`	`anyMethod()`
`protected AnyOfRule`	`anyOptionalMethod()`
`protected AnyOfRule`	`anyResourceTypeMethod()`
`protected Rule`	`anyTypeReference(String referenceKey, Class<? extends Node> simpleClass, Class<? extends Node> parametrisedClass)`
`protected Rule`	`authorizationGrantsValue()`
`protected ObjectRule`	`baseResourceValue()`
`protected KeyValueRule`	`baseUriField()`
`protected StringValueRule`	`baseUriKey()`
`protected KeyValueRule`	`baseUriParametersField()`
`protected StringValueRule`	`baseUriParametersKey()`
`protected Rule`	`body()`
`protected KeyValueRule`	`bodyField()`
`protected StringValueRule`	`bodyKey()`
`protected KeyValueRule`	`contentField()`
`protected KeyValueRule`	`descriptionField()`
`protected StringValueRule`	`descriptionKey()`
`protected Rule`	`descriptionValue()`
`protected KeyValueRule`	`displayNameField()`
`protected StringValueRule`	`displayNameKey()`
`protected KeyValueRule`	`docTitleField()`
`ObjectRule`	`documentation()`
`protected StringValueRule`	`documentationKey()`
`protected Rule`	`documentations()`
`protected ExclusiveSiblingRule`	`exclusiveWith(String key, String... notAllowedSiblings)`
`protected KeyValueRule`	`headersField()`
`protected StringValueRule`	`headersKey()`
`protected KeyValueRule`	`isField()`
`protected StringValueRule`	`isKey()`
`protected KeyValueRule`	`mediaTypeField()`
`protected StringValueRule`	`mediaTypeKey()`
`protected KeyValueRule`	`methodField()`
`protected ObjectRule`	`methodValue()`
`protected abstract Rule`	`mimeType()`
`KeyValueRule`	`mimeTypeField()`
`RegexValueRule`	`mimeTypeRegex()`
`protected NodeReferenceRule`	`nodeRef(String referenceKey)`
`protected abstract Rule`	`parameter()` Describes the rule for a parameter.
`protected Rule`	`parameters()`
`protected Rule`	`protocols()`
`protected KeyValueRule`	`protocolsField()`
`protected StringValueRule`	`protocolsKey()`
`protected KeyValueRule`	`queryParametersField()`
`protected StringValueRule`	`queryParametersKey()`
`protected StringValueRule`	`queryStringKey()`
`ObjectRule`	`raml()`
`protected Rule`	`ramlScalarValue()`
`protected KeyValueRule`	`resourceField()`
`protected Rule`	`resourceKey()`
`ObjectRule`	`resourceType()`
`ObjectRule`	`resourceTypeParamsResolved()`
`protected KeyValueRule`	`resourceTypeReferenceField()`
`protected StringValueRule`	`resourceTypeRefKey()`
`protected Rule`	`resourceTypes()`
`protected KeyValueRule`	`resourceTypesField()`
`protected StringValueRule`	`resourceTypesKey()`
`protected Rule`	`resourceTypesValue()`
`protected ObjectRule`	`resourceValue()`
`protected ObjectRule`	`response()`
`protected Rule`	`responseCodes()`
`protected KeyValueRule`	`responseField()`
`protected StringValueRule`	`responseKey()`
`protected Rule`	`responses()`
`protected KeyValueRule`	`responsesField()`
`protected abstract String`	`schemasDescription()`
`protected KeyValueRule`	`schemasField()`
`protected StringValueRule`	`schemasKey()`
`protected abstract Rule`	`schemasValue()`
`protected KeyValueRule`	`securedByField()`
`protected StringValueRule`	`securedByKey()`
`ObjectRule`	`securityScheme()`
`protected ObjectRule`	`securitySchemePart()`
`protected Rule`	`securitySchemes()`
`protected ObjectRule`	`securitySchemeSettings()`
`protected KeyValueRule`	`securitySchemesField()`
`protected StringValueRule`	`securitySchemesKey()`
`protected abstract Rule`	`securitySchemesValue()`
`protected StringValueRule`	`securitySchemeTypeKey()`
`protected KeyValueRule`	`titleField()`
`protected StringValueRule`	`titleKey()`
`protected Rule`	`titleValue()`
`ObjectRule`	`trait()`
`ObjectRule`	`traitParamsResolved()`
`protected KeyValueRule`	`traitsField()`
`protected StringValueRule`	`traitsKey()`
`protected Rule`	`traitsValue()`
`protected StringValueRule`	`typeKey()`
`ObjectRule`	`untitledRaml()`
`protected StringValueRule`	`uriParametersKey()`
`protected KeyValueRule`	`usageField()`
`protected StringValueRule`	`usesKey()`
`protected KeyValueRule`	`versionField()`
`protected StringValueRule`	`versionKey()`

Methods inherited from class org.raml.yagi.framework.grammar.BaseGrammar
allOf, any, anyOf, anyOf, array, booleanType, exclusiveKeys, field, field, fieldWithRequiredValue, firstOf, inNewContext, integer, integerType, is, minLength, named, not, nullValue, numberType, objectType, optional, parentKey, positiveIntegerType, positiveNumberType, range, regex, regex, requiredField, scalarType, string, stringType, when, when, whenChildIs, whenPresent

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

Field Detail
- USES_KEY_NAME
```
public static final String USES_KEY_NAME
```
  See Also:
  
  Constant Field Values
- RESOURCE_TYPES_KEY_NAME
```
public static final String RESOURCE_TYPES_KEY_NAME
```
  See Also:
  
  Constant Field Values
- TRAITS_KEY_NAME
```
public static final String TRAITS_KEY_NAME
```
  See Also:
  
  Constant Field Values
- TYPES_KEY_NAME
```
public static final String TYPES_KEY_NAME
```
  See Also:
  
  Constant Field Values
- SCHEMAS_KEY_NAME
```
public static final String SCHEMAS_KEY_NAME
```
  See Also:
  
  Constant Field Values
- QUERY_PARAMETERS_KEY_NAME
```
public static final String QUERY_PARAMETERS_KEY_NAME
```
  See Also:
  
  Constant Field Values
- QUERY_STRING_KEY_NAME
```
public static final String QUERY_STRING_KEY_NAME
```
  See Also:
  
  Constant Field Values
- SECURITY_SCHEMES_KEY_NAME
```
public static final String SECURITY_SCHEMES_KEY_NAME
```
  See Also:
  
  Constant Field Values
- MIME_TYPE_REGEX
```
public static final String MIME_TYPE_REGEX
```
  See Also:
  
  Constant Field Values
- OAUTH_1_0
```
public static final String OAUTH_1_0
```
  See Also:
  
  Constant Field Values
- OAUTH_2_0
```
public static final String OAUTH_2_0
```
  See Also:
  
  Constant Field Values

Constructor Detail
- BaseRamlGrammar
```
public BaseRamlGrammar()
```

Method Detail

raml
```
public ObjectRule raml()
```

nodeRef

protected NodeReferenceRule nodeRef(String referenceKey)

untitledRaml
```
public ObjectRule untitledRaml()
```

baseUriParametersField

protected KeyValueRule baseUriParametersField()

baseUriField
```
protected KeyValueRule baseUriField()
```

docTitleField

protected KeyValueRule docTitleField()

titleField
```
protected KeyValueRule titleField()
```

titleValue
```
protected Rule titleValue()
```

resourceField

protected KeyValueRule resourceField()

versionField
```
protected KeyValueRule versionField()
```

ramlScalarValue
```
protected Rule ramlScalarValue()
```

mediaTypeField

protected KeyValueRule mediaTypeField()

resourceType
```
public ObjectRule resourceType()
```

resourceTypeParamsResolved

public ObjectRule resourceTypeParamsResolved()

traitParamsResolved

public ObjectRule traitParamsResolved()

documentations
```
protected Rule documentations()
```

documentation
```
public ObjectRule documentation()
```

contentField
```
protected KeyValueRule contentField()
```

securitySchemes
```
protected Rule securitySchemes()
```

securityScheme
```
public ObjectRule securityScheme()
```

securitySchemePart

protected ObjectRule securitySchemePart()

securitySchemeSettings

protected ObjectRule securitySchemeSettings()

authorizationGrantsValue

protected Rule authorizationGrantsValue()

traitsValue
```
protected Rule traitsValue()
```

trait
```
public ObjectRule trait()
```

resourceTypes
```
protected Rule resourceTypes()
```

resourceValue
```
protected ObjectRule resourceValue()
```

methodField
```
protected KeyValueRule methodField()
```

baseResourceValue

protected ObjectRule baseResourceValue()

methodValue
```
protected ObjectRule methodValue()
```

queryParametersField

protected KeyValueRule queryParametersField()

responsesField

protected KeyValueRule responsesField()

responseKey

protected StringValueRule responseKey()

queryStringKey

protected StringValueRule queryStringKey()

queryParametersKey

protected StringValueRule queryParametersKey()

responses
```
protected Rule responses()
```

responseField

protected KeyValueRule responseField()

response
```
protected ObjectRule response()
```

body
```
protected Rule body()
```

mimeTypeField
```
public KeyValueRule mimeTypeField()
```

mimeTypeRegex
```
public RegexValueRule mimeTypeRegex()
```

mimeType
```
protected abstract Rule mimeType()
```

parameters
```
protected Rule parameters()
```

parameter
```
protected abstract Rule parameter()
```
Describes the rule for a parameter.

exclusiveWith

protected ExclusiveSiblingRule exclusiveWith(String key,
                                             String... notAllowedSiblings)

securitySchemesField

protected KeyValueRule securitySchemesField()

securitySchemesValue

protected abstract Rule securitySchemesValue()

securitySchemesKey

protected StringValueRule securitySchemesKey()

schemasField
```
protected KeyValueRule schemasField()
```

schemasValue

protected abstract Rule schemasValue()

schemasKey

protected StringValueRule schemasKey()

schemasDescription

@Nonnull
protected abstract String schemasDescription()

resourceTypesField

protected KeyValueRule resourceTypesField()

resourceTypesValue
```
protected Rule resourceTypesValue()
```

resourceTypesKey

protected StringValueRule resourceTypesKey()

traitsField
```
protected KeyValueRule traitsField()
```

traitsKey
```
protected StringValueRule traitsKey()
```

protocolsField

protected KeyValueRule protocolsField()

protocolsKey

protected StringValueRule protocolsKey()

bodyField
```
protected KeyValueRule bodyField()
```

bodyKey
```
protected StringValueRule bodyKey()
```

headersField
```
protected KeyValueRule headersField()
```

headersKey

protected StringValueRule headersKey()

descriptionField

protected KeyValueRule descriptionField()

descriptionValue
```
protected Rule descriptionValue()
```

displayNameField

protected KeyValueRule displayNameField()

securedByField

protected KeyValueRule securedByField()

usageField
```
protected KeyValueRule usageField()
```

isField
```
protected KeyValueRule isField()
```

resourceTypeReferenceField

protected KeyValueRule resourceTypeReferenceField()

anyTypeReference

protected Rule anyTypeReference(String referenceKey,
                                Class<? extends Node> simpleClass,
                                Class<? extends Node> parametrisedClass)

titleKey
```
protected StringValueRule titleKey()
```

resourceKey
```
protected Rule resourceKey()
```

usesKey
```
protected StringValueRule usesKey()
```

uriParametersKey

protected StringValueRule uriParametersKey()

securedByKey

protected StringValueRule securedByKey()

typeKey
```
protected StringValueRule typeKey()
```

securitySchemeTypeKey

protected StringValueRule securitySchemeTypeKey()

resourceTypeRefKey

protected StringValueRule resourceTypeRefKey()

isKey
```
protected StringValueRule isKey()
```

displayNameKey

protected StringValueRule displayNameKey()

descriptionKey

protected StringValueRule descriptionKey()

documentationKey

protected StringValueRule documentationKey()

mediaTypeKey

protected StringValueRule mediaTypeKey()

baseUriParametersKey

protected StringValueRule baseUriParametersKey()

baseUriKey

protected StringValueRule baseUriKey()

versionKey

protected StringValueRule versionKey()

anyMethod
```
protected AnyOfRule anyMethod()
```

anyOptionalMethod

protected AnyOfRule anyOptionalMethod()

anyResourceTypeMethod

protected AnyOfRule anyResourceTypeMethod()

protocols
```
protected Rule protocols()
```

responseCodes
```
protected Rule responseCodes()
```

Class BaseRamlGrammar

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.raml.yagi.framework.grammar.BaseGrammar

Methods inherited from class java.lang.Object

Field Detail

USES_KEY_NAME

RESOURCE_TYPES_KEY_NAME

TRAITS_KEY_NAME

TYPES_KEY_NAME

SCHEMAS_KEY_NAME

QUERY_PARAMETERS_KEY_NAME

QUERY_STRING_KEY_NAME

SECURITY_SCHEMES_KEY_NAME

MIME_TYPE_REGEX

OAUTH_1_0

OAUTH_2_0

Constructor Detail

BaseRamlGrammar

Method Detail

raml

nodeRef

untitledRaml

baseUriParametersField

baseUriField

docTitleField

titleField

titleValue

resourceField

versionField

ramlScalarValue

mediaTypeField

resourceType

resourceTypeParamsResolved

traitParamsResolved

documentations

documentation

contentField

securitySchemes

securityScheme

securitySchemePart

securitySchemeSettings

authorizationGrantsValue

traitsValue

trait

resourceTypes

resourceValue

methodField

baseResourceValue

methodValue

queryParametersField

responsesField

responseKey

queryStringKey

queryParametersKey

responses

responseField

response

body

mimeTypeField

mimeTypeRegex

mimeType

parameters

parameter

exclusiveWith

securitySchemesField

securitySchemesValue

securitySchemesKey

schemasField

schemasValue

schemasKey

schemasDescription

resourceTypesField

resourceTypesValue

resourceTypesKey

traitsField

traitsKey

protocolsField

protocolsKey