Raml10Grammar (Raml Java Parser 2nd generation 1.0.9 API)

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

public class Raml10Grammar
extends BaseRamlGrammar

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADDITIONAL_PROPERTIES_KEY_NAME`
`static String`	`ANNOTATION_TYPES_KEY_NAME`
`static String`	`DEFAULT_TYPE_RULE`
`static String`	`DISCRIMINATOR_KEY_NAME`
`static String`	`DISCRIMINATOR_VALUE_KEY_NAME`
`static String`	`ENUM_KEY_NAME`
`static String`	`FILE_TYPES_KEY_NAME`
`static String`	`FORMAT_KEY_NAME`
`static String`	`ITEMS_KEY_NAME`
`static String`	`MAX_ITEMS_KEY_NAME`
`static String`	`MAX_LENGTH_KEY_NAME`
`static String`	`MAX_PROPERTIES_KEY_NAME`
`static String`	`MAXIMUM_KEY_NAME`
`static String`	`MIN_ITEMS_KEY_NAME`
`static String`	`MIN_LENGTH_KEY_NAME`
`static String`	`MIN_PROPERTIES_KEY_NAME`
`static String`	`MINIMUM_KEY_NAME`
`static String`	`MULTIPLE_OF_KEY_NAME`
`static String`	`PATTERN_KEY_NAME`
`static String`	`PROPERTIES_KEY_NAME`
`static String`	`PROPERTY_TYPE_RULE`
`static String`	`TYPES_FACET_SCHEMA`
`static String`	`TYPES_FACET_TYPE`
`static String`	`UNIQUE_ITEMS_KEY_NAME`

Fields inherited from class org.raml.v2.internal.impl.commons.grammar.BaseRamlGrammar
MIME_TYPE_REGEX, OAUTH_1_0, OAUTH_2_0, QUERY_PARAMETERS_KEY_NAME, QUERY_STRING_KEY_NAME, RESOURCE_TYPES_KEY_NAME, SCHEMAS_KEY_NAME, SECURITY_SCHEMES_KEY_NAME, TRAITS_KEY_NAME, TYPES_KEY_NAME, USES_KEY_NAME

Constructor Summary

Constructors
Constructor and Description

Raml10Grammar()

Constructors
Constructor and Description
`Raml10Grammar()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KeyValueRule`	`additionalPropertiesField()`
`protected Rule`	`annotatedScalarType()`
`protected Rule`	`annotatedScalarType(Rule customScalarRule)`
`protected KeyValueRule`	`annotationField()`
`protected RegexValueRule`	`annotationKey()`
`ObjectRule`	`annotationTypeDeclaration()`
`protected Rule`	`annotationTypes()`
`protected KeyValueRule`	`annotationTypesField()`
`protected StringValueRule`	`annotationTypesKey()`
`protected AnyOfRule`	`arrayTypeLiteral()`
`protected Rule`	`authorizationGrantsValue()`
`protected StringValueRule`	`booleanTypeLiteral()`
`protected Rule`	`builtinTypes()`
`protected Rule`	`descriptionValue()`
`KeyValueRule`	`discriminatorField()`
`KeyValueRule`	`discriminatorValueField()`
`protected KeyValueRule`	`displayNameField()`
`protected KeyValueRule`	`docTitleField()`
`ObjectRule`	`documentation()`
`KeyValueRule`	`enumField()`
`protected KeyValueRule`	`exampleField()`
`Rule`	`exampleFragment()`
`protected KeyValueRule`	`examplesField()`
`protected ObjectRule`	`examplesValue()`
`protected Rule`	`exampleValue()`
`ObjectRule`	`explicitType()`
`protected StringValueRule`	`extendsKey()`
`ObjectRule`	`extension()`
`protected KeyValueRule`	`facetsField()`
`protected StringValueRule`	`fileTypeLiteral()`
`KeyValueRule`	`fileTypesField()`
`KeyValueRule`	`formatField()`
`protected Rule`	`inlineType()`
`protected Rule`	`integerTypeLiteral()`
`KeyValueRule`	`itemsField()`
`Rule`	`libraryRef()`
`ObjectRule`	`libraryValue()`
`KeyValueRule`	`maximumField(Rule rule)`
`KeyValueRule`	`maxItemsField()`
`KeyValueRule`	`maxLengthField()`
`KeyValueRule`	`maxPropertiesField()`
`protected KeyValueRule`	`mediaTypeField()`
`protected ObjectRule`	`methodValue()`
`protected Rule`	`mimeType()`
`KeyValueRule`	`minimumField(Rule rule)`
`KeyValueRule`	`minItemsField()`
`KeyValueRule`	`minLengthField()`
`KeyValueRule`	`minPropertiesField()`
`KeyValueRule`	`multipleOfField(Rule rule)`
`KeyValueRule`	`numberFormat()`
`protected Rule`	`numberTypeLiteral()`
`protected Rule`	`numericTypeLiteral()`
`protected Rule`	`objectTypeLiteral()`
`protected KeyValueRule`	`optionalTitleField()`
`protected Rule`	`overlayableRamlScalarValue()`
`protected Rule`	`parameter()` Describes the rule for a parameter.
`protected Rule`	`parameters()`
`KeyValueRule`	`patternField()`
`protected ObjectRule`	`properties()`
`KeyValueRule`	`propertiesField()`
`Rule`	`ramlScalarValue()`
`protected Rule`	`ramlTypeKey()`
`protected Rule`	`resourceTypesValue()`
`protected ObjectRule`	`resourceValue()`
`protected ObjectRule`	`response()`
`protected KeyValueRule`	`responseField()`
`protected String`	`schemasDescription()`
`protected KeyValueRule`	`schemasField()`
`protected Rule`	`schemasValue()`
`ObjectRule`	`securityScheme()`
`protected ObjectRule`	`securitySchemePart()`
`protected ObjectRule`	`securitySchemeSettings()`
`protected Rule`	`securitySchemesValue()`
`protected StringValueRule`	`stringTypeLiteral()`
`protected Rule`	`titleValue()`
`Rule`	`type()`
`protected Rule`	`types()`
`protected KeyValueRule`	`typesField()`
`protected StringValueRule`	`typesKey()`
`KeyValueRule`	`uniqueItemsField()`
`ObjectRule`	`untitledRaml()`
`KeyValueRule`	`usesField()`

Methods inherited from class org.raml.v2.internal.impl.commons.grammar.BaseRamlGrammar
anyMethod, anyOptionalMethod, anyResourceTypeMethod, anyTypeReference, baseResourceValue, baseUriField, baseUriKey, baseUriParametersField, baseUriParametersKey, body, bodyField, bodyKey, contentField, descriptionField, descriptionKey, displayNameKey, documentationKey, documentations, exclusiveWith, headersField, headersKey, isField, isKey, mediaTypeKey, methodField, mimeTypeField, mimeTypeRegex, nodeRef, protocols, protocolsField, protocolsKey, queryParametersKey, queryStringKey, raml, resourceField, resourceKey, resourceType, resourceTypeParamsResolved, resourceTypeReferenceField, resourceTypeRefKey, resourceTypes, resourceTypesField, resourceTypesKey, responseCodes, responseKey, responses, schemasKey, securedByField, securedByKey, securitySchemes, securitySchemesField, securitySchemesKey, securitySchemeTypeKey, titleField, titleKey, trait, traitParamsResolved, traitsField, traitsKey, traitsValue, typeKey, uriParametersKey, usageField, usesKey, versionField, 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

ANNOTATION_TYPES_KEY_NAME

public static final String ANNOTATION_TYPES_KEY_NAME

See Also:: Constant Field Values

DEFAULT_TYPE_RULE

public static final String DEFAULT_TYPE_RULE

See Also:: Constant Field Values

PROPERTY_TYPE_RULE

public static final String PROPERTY_TYPE_RULE

See Also:: Constant Field Values

TYPES_FACET_TYPE

public static final String TYPES_FACET_TYPE

See Also:: Constant Field Values

TYPES_FACET_SCHEMA

public static final String TYPES_FACET_SCHEMA

See Also:: Constant Field Values

MIN_ITEMS_KEY_NAME

public static final String MIN_ITEMS_KEY_NAME

See Also:: Constant Field Values

MAX_ITEMS_KEY_NAME

public static final String MAX_ITEMS_KEY_NAME

See Also:: Constant Field Values

UNIQUE_ITEMS_KEY_NAME

public static final String UNIQUE_ITEMS_KEY_NAME

See Also:: Constant Field Values

ITEMS_KEY_NAME

public static final String ITEMS_KEY_NAME

See Also:: Constant Field Values

FILE_TYPES_KEY_NAME

public static final String FILE_TYPES_KEY_NAME

See Also:: Constant Field Values

MIN_LENGTH_KEY_NAME

public static final String MIN_LENGTH_KEY_NAME

See Also:: Constant Field Values

MAX_LENGTH_KEY_NAME

public static final String MAX_LENGTH_KEY_NAME

See Also:: Constant Field Values

MINIMUM_KEY_NAME

public static final String MINIMUM_KEY_NAME

See Also:: Constant Field Values

MAXIMUM_KEY_NAME

public static final String MAXIMUM_KEY_NAME

See Also:: Constant Field Values

FORMAT_KEY_NAME

public static final String FORMAT_KEY_NAME

See Also:: Constant Field Values

ENUM_KEY_NAME

public static final String ENUM_KEY_NAME

See Also:: Constant Field Values

MULTIPLE_OF_KEY_NAME

public static final String MULTIPLE_OF_KEY_NAME

See Also:: Constant Field Values

PROPERTIES_KEY_NAME

public static final String PROPERTIES_KEY_NAME

See Also:: Constant Field Values

MIN_PROPERTIES_KEY_NAME

public static final String MIN_PROPERTIES_KEY_NAME

See Also:: Constant Field Values

MAX_PROPERTIES_KEY_NAME

public static final String MAX_PROPERTIES_KEY_NAME

See Also:: Constant Field Values

ADDITIONAL_PROPERTIES_KEY_NAME

public static final String ADDITIONAL_PROPERTIES_KEY_NAME

See Also:: Constant Field Values

DISCRIMINATOR_KEY_NAME

public static final String DISCRIMINATOR_KEY_NAME

See Also:: Constant Field Values

DISCRIMINATOR_VALUE_KEY_NAME

public static final String DISCRIMINATOR_VALUE_KEY_NAME

See Also:: Constant Field Values

PATTERN_KEY_NAME

public static final String PATTERN_KEY_NAME

See Also:: Constant Field Values

Constructor Detail
- Raml10Grammar
```
public Raml10Grammar()
```

Method Detail

untitledRaml
```
public ObjectRule untitledRaml()
```
Overrides:

untitledRaml in class BaseRamlGrammar

resourceValue
```
protected ObjectRule resourceValue()
```
Overrides:

resourceValue in class BaseRamlGrammar

methodValue
```
protected ObjectRule methodValue()
```
Overrides:

methodValue in class BaseRamlGrammar

securityScheme
```
public ObjectRule securityScheme()
```
Overrides:

securityScheme in class BaseRamlGrammar

securitySchemePart
```
protected ObjectRule securitySchemePart()
```
Overrides:

securitySchemePart in class BaseRamlGrammar

securitySchemeSettings
```
protected ObjectRule securitySchemeSettings()
```
Overrides:

securitySchemeSettings in class BaseRamlGrammar

authorizationGrantsValue
```
protected Rule authorizationGrantsValue()
```
Overrides:

authorizationGrantsValue in class BaseRamlGrammar

responseField
```
protected KeyValueRule responseField()
```
Overrides:

responseField 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
```
public KeyValueRule usesField()
```

extension
```
public ObjectRule extension()
```

extendsKey

protected StringValueRule extendsKey()

optionalTitleField

protected KeyValueRule optionalTitleField()

libraryRef
```
public Rule libraryRef()
```

libraryValue
```
public ObjectRule libraryValue()
```

annotationTypesField

protected KeyValueRule annotationTypesField()

annotationTypesKey

protected StringValueRule annotationTypesKey()

annotationTypes
```
protected Rule annotationTypes()
```

types
```
protected Rule types()
```

ramlTypeKey
```
protected Rule ramlTypeKey()
```

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()
```

inlineType
```
protected Rule inlineType()
```

explicitType
```
public ObjectRule explicitType()
```

annotationTypeDeclaration

public ObjectRule annotationTypeDeclaration()

builtinTypes
```
protected Rule builtinTypes()
```

discriminatorValueField

public KeyValueRule discriminatorValueField()

discriminatorField

public KeyValueRule discriminatorField()

additionalPropertiesField

public KeyValueRule additionalPropertiesField()

maxPropertiesField

public KeyValueRule maxPropertiesField()

minPropertiesField

public KeyValueRule minPropertiesField()

propertiesField
```
public KeyValueRule propertiesField()
```

fileTypesField
```
public KeyValueRule fileTypesField()
```

multipleOfField

public KeyValueRule multipleOfField(Rule rule)

numberFormat
```
public KeyValueRule numberFormat()
```

maximumField

public KeyValueRule maximumField(Rule rule)

minimumField

public KeyValueRule minimumField(Rule rule)

maxItemsField
```
public KeyValueRule maxItemsField()
```

minItemsField
```
public KeyValueRule minItemsField()
```

itemsField
```
public KeyValueRule itemsField()
```

uniqueItemsField

public KeyValueRule uniqueItemsField()

formatField
```
public KeyValueRule formatField()
```

enumField
```
public KeyValueRule enumField()
```

maxLengthField
```
public KeyValueRule maxLengthField()
```

minLengthField
```
public KeyValueRule minLengthField()
```

patternField
```
public KeyValueRule patternField()
```

examplesField

protected KeyValueRule examplesField()

exampleField
```
protected KeyValueRule exampleField()
```

facetsField
```
protected KeyValueRule facetsField()
```

examplesValue
```
protected ObjectRule examplesValue()
```

mimeType
```
protected Rule mimeType()
```
Specified by:

mimeType in class BaseRamlGrammar

exampleValue
```
protected Rule exampleValue()
```

exampleFragment
```
public Rule exampleFragment()
```

fileTypeLiteral

protected StringValueRule fileTypeLiteral()

numericTypeLiteral
```
protected Rule numericTypeLiteral()
```

numberTypeLiteral
```
protected Rule numberTypeLiteral()
```

integerTypeLiteral
```
protected Rule integerTypeLiteral()
```

stringTypeLiteral

protected StringValueRule stringTypeLiteral()

booleanTypeLiteral

protected StringValueRule booleanTypeLiteral()

arrayTypeLiteral

protected AnyOfRule arrayTypeLiteral()

properties
```
protected ObjectRule properties()
```

parameters
```
protected Rule parameters()
```
Overrides:

parameters in class BaseRamlGrammar

objectTypeLiteral
```
protected Rule objectTypeLiteral()
```

mediaTypeField
```
protected KeyValueRule mediaTypeField()
```
Overrides:

mediaTypeField in class BaseRamlGrammar

schemasField
```
protected KeyValueRule schemasField()
```
Overrides:

schemasField in class BaseRamlGrammar

schemasValue
```
protected Rule schemasValue()
```
Specified by:

schemasValue in class BaseRamlGrammar

schemasDescription
```
@Nonnull
protected String schemasDescription()
```
Specified by:

schemasDescription in class BaseRamlGrammar

displayNameField
```
protected KeyValueRule displayNameField()
```
Overrides:

displayNameField in class BaseRamlGrammar

overlayableRamlScalarValue

protected Rule overlayableRamlScalarValue()

resourceTypesValue
```
protected Rule resourceTypesValue()
```
Overrides:

resourceTypesValue in class BaseRamlGrammar

securitySchemesValue
```
protected Rule securitySchemesValue()
```
Specified by:

securitySchemesValue in class BaseRamlGrammar

descriptionValue
```
protected Rule descriptionValue()
```
Overrides:

descriptionValue in class BaseRamlGrammar

docTitleField
```
protected KeyValueRule docTitleField()
```
Overrides:

docTitleField in class BaseRamlGrammar

titleValue
```
protected Rule titleValue()
```
Overrides:

titleValue in class BaseRamlGrammar

ramlScalarValue
```
public Rule ramlScalarValue()
```
Overrides:

ramlScalarValue in class BaseRamlGrammar

annotatedScalarType
```
protected Rule annotatedScalarType()
```

annotatedScalarType

protected Rule annotatedScalarType(Rule customScalarRule)

documentation
```
public ObjectRule documentation()
```
Overrides:

documentation in class BaseRamlGrammar

Class Raml10Grammar

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

ANNOTATION_TYPES_KEY_NAME

DEFAULT_TYPE_RULE

PROPERTY_TYPE_RULE

TYPES_FACET_TYPE

TYPES_FACET_SCHEMA

MIN_ITEMS_KEY_NAME

MAX_ITEMS_KEY_NAME

UNIQUE_ITEMS_KEY_NAME

ITEMS_KEY_NAME

FILE_TYPES_KEY_NAME

MIN_LENGTH_KEY_NAME

MAX_LENGTH_KEY_NAME

MINIMUM_KEY_NAME

MAXIMUM_KEY_NAME

FORMAT_KEY_NAME

ENUM_KEY_NAME

MULTIPLE_OF_KEY_NAME

PROPERTIES_KEY_NAME

MIN_PROPERTIES_KEY_NAME

MAX_PROPERTIES_KEY_NAME

ADDITIONAL_PROPERTIES_KEY_NAME

DISCRIMINATOR_KEY_NAME

DISCRIMINATOR_VALUE_KEY_NAME

PATTERN_KEY_NAME

Constructor Detail

Raml10Grammar

Method Detail

untitledRaml

resourceValue

methodValue

securityScheme

securitySchemePart

securitySchemeSettings

authorizationGrantsValue

responseField

response

typesField

typesKey

annotationField

annotationKey

usesField

extension

extendsKey

optionalTitleField

libraryRef

libraryValue

annotationTypesField

annotationTypesKey

annotationTypes

types

ramlTypeKey

parameter

type

inlineType

explicitType

annotationTypeDeclaration

builtinTypes

discriminatorValueField

discriminatorField

additionalPropertiesField

maxPropertiesField

minPropertiesField

propertiesField

fileTypesField

multipleOfField

numberFormat

maximumField

minimumField

maxItemsField

minItemsField

itemsField