BaseGrammar (Yaml Grammar 1.0.28 API)

java.lang.Object
- org.raml.yagi.framework.grammar.BaseGrammar

```
public class BaseGrammar
extends Object
```
Base class for rule based grammars.

Constructor Summary

Constructors
Constructor and Description

BaseGrammar()

Constructors
Constructor and Description
`BaseGrammar()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AllOfRule`	`allOf(Rule... rules)` Matches if all the specified rules matches
`AnyValueRule`	`any()` Matches any value
`AnyOfRule`	`anyOf(List<Rule> rules)` Matches if any rule matches and suggests all the possibilities.
`AnyOfRule`	`anyOf(Rule... rules)` Matches if any rule matches and suggests all the possibilities.
`ArrayRule`	`array(Rule of)` Matches an array value
`BooleanTypeRule`	`booleanType()` Matches any Boolean type value
`ExclusiveKeys`	`exclusiveKeys(String... keys)` Creates a new set of exclusive rules
`KeyValueRule`	`field(Rule keyRule, Rule valueRule)` Matches a field that the key matches the key rule and the value the value rule
`KeyValueRule`	`field(String keyName, Rule valueRule)` Matches a field that the key is of string type and matches the specified key name and the value matches the value rule or null value
`KeyValueRule`	`fieldWithRequiredValue(Rule keyRule, Rule valueRule)` Matches a field that the key is of string type and matches the specified key name and the value matches the value rule.
`AnyOfRule`	`firstOf(Rule... rules)` Accepts if any rule matches and delegates the suggestion to the first one that matches.
`<T extends Rule> T`	`inNewContext(Callable<T> callable)` Returns rule created by the callable that runs a new separate context.
`IntegerValueRule`	`integer(Integer value)` Matches a number that is Integer and its value it the specified
`IntegerTypeRule`	`integerType()` Matches a number that is Integer
`ConditionalRule`	`is(Rule rule)` Conditional rule that will accept if the rule matches
`MinLengthRule`	`minLength(int length)` Matches a string that its length is bigger or equals to the specified
`<T extends Rule> T`	`named(String name, RuleFactory<T> ruleFactory)` Registers a rule with the specified name.
`NegativeRule`	`not(Rule rule)` Matches if the specified rule does not match
`protected NullValueRule`	`nullValue()` Matches a null value.
`Rule`	`numberType()` Matches any type of number
`ObjectRule`	`objectType()` Matches an object type
`AnyOfRule`	`optional(Rule rule)` Matches if the rule matches or the value is null
`DefaultValue`	`parentKey()` Returns a default value that is the parent key
`IntegerTypeRule`	`positiveIntegerType(boolean includesZero, Long maxValue)` Matches an integer greater than zero
`Rule`	`positiveNumberType()` Matches any number greater than zero
`RangeValueRule`	`range(Integer min, Integer max)` Matches a number that is Integer and is included in the range
`RegexValueRule`	`regex(Pattern pattern)` Matches any value that is accepted by the regex pattern
`RegexValueRule`	`regex(String pattern)` Matches any value that is accepted by the regex pattern
`KeyValueRule`	`requiredField(Rule keyRule, Rule valueRule)` Matches a field that the key is of string type and matches the specified key name and the value matches the value rule.
`Rule`	`scalarType()` Matches any scalar value e.g Number String boolean etc
`StringValueRule`	`string(String value)` Matches any value of type string with the specified value
`StringTypeRule`	`stringType()` Matches any String type value
`ConditionalRules`	`when(List<String> expr, ConditionalRule... cases)` It will dispatch the to the conditional rule that matches the selected value.
`ConditionalRules`	`when(String expr, ConditionalRule... cases)` It will dispatch the to the conditional rule that matches the selected value.
`ChildBasedConditionalRule`	`whenChildIs(Rule condition, Rule then)` Delegates to a rule if the specified condition matches the first child.
`FieldPresentRule`	`whenPresent(String selector, Rule then)` Delegates to a rule if a selector expression returns a value

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

- Constructor Detail
  - BaseGrammar
```
public BaseGrammar()
```
- Method Detail
  - objectType
```
public ObjectRule objectType()
```
    Matches an object type
    
    Returns:
    
    The object rule
  - named
```
public <T extends Rule> T named(String name,
                                RuleFactory<T> ruleFactory)
```
    Registers a rule with the specified name. If the rule is already defined then it returns it otherwise it will invoke the rule factory to create.
    
    Type Parameters:
    
    T - The node type
    
    Parameters:
    
    name - The name of the rule
    
    ruleFactory - The factory of the rule
    
    Returns:
    
    The rule
  - inNewContext
```
public <T extends Rule> T inNewContext(Callable<T> callable)
```
    Returns rule created by the callable that runs a new separate context.
    
    Type Parameters:
    
    T - The type of rule it returns
    
    Parameters:
    
    callable - The callable to execute in a new context
    
    Returns:
    
    The rule
  - whenChildIs
```
public ChildBasedConditionalRule whenChildIs(Rule condition,
                                             Rule then)
```
    Delegates to a rule if the specified condition matches the first child.
    
    Parameters:
    
    condition - The condition
    
    then - the rule to be delegated
  - whenPresent
```
public FieldPresentRule whenPresent(String selector,
                                    Rule then)
```
    Delegates to a rule if a selector expression returns a value
    
    Parameters:
    
    selector - The selector expression
    
    then - The rule to be delegated if the selector returns a value
  - any
```
public AnyValueRule any()
```
    Matches any value
    
    Returns:
    
    Any value rule
  - array
```
public ArrayRule array(Rule of)
```
    Matches an array value
    
    Parameters:
    
    of - The type of the array
    
    Returns:
    
    The array rule
  - integerType
```
public IntegerTypeRule integerType()
```
    Matches a number that is Integer
    
    Returns:
    
    The rule
  - positiveIntegerType
```
public IntegerTypeRule positiveIntegerType(boolean includesZero,
                                           Long maxValue)
```
    Matches an integer greater than zero
    
    Returns:
    
    The rule
  - numberType
```
public Rule numberType()
```
    Matches any type of number
    
    Returns:
    
    The rule
  - positiveNumberType
```
public Rule positiveNumberType()
```
    Matches any number greater than zero
    
    Returns:
    
    The rule
  - range
```
public RangeValueRule range(Integer min,
                            Integer max)
```
    Matches a number that is Integer and is included in the range
    
    Returns:
    
    The rule
  - integer
```
public IntegerValueRule integer(Integer value)
```
    Matches a number that is Integer and its value it the specified
    
    Parameters:
    
    value - The value to match
    
    Returns:
    
    The rule
  - field
```
public KeyValueRule field(Rule keyRule,
                          Rule valueRule)
```
    Matches a field that the key matches the key rule and the value the value rule
    
    Parameters:
    
    keyRule - The key rule
    
    valueRule - The value rule
    
    Returns:
    
    The rule
  - field
```
public KeyValueRule field(String keyName,
                          Rule valueRule)
```
    Matches a field that the key is of string type and matches the specified key name and the value matches the value rule or null value
    
    Parameters:
    
    keyName - The key name
    
    valueRule - The value rule
    
    Returns:
    
    The rule
  - fieldWithRequiredValue
```
public KeyValueRule fieldWithRequiredValue(Rule keyRule,
                                           Rule valueRule)
```
    Matches a field that the key is of string type and matches the specified key name and the value matches the value rule. The difference with the this#field(String, Rule) it that Null is not matched for the value.
    
    Parameters:
    
    keyRule - The key rule
    
    valueRule - The value rule
    
    Returns:
    
    The rule
  - requiredField
```
public KeyValueRule requiredField(Rule keyRule,
                                  Rule valueRule)
```
    Matches a field that the key is of string type and matches the specified key name and the value matches the value rule. The difference with the this#field(String, Rule) it that Null is not matched for the value and also mark this field as required in the object rule.
    
    Parameters:
    
    keyRule - The key rule
    
    valueRule - The value rule
    
    Returns:
    
    The rule
  - scalarType
```
public Rule scalarType()
```
    Matches any scalar value e.g Number String boolean etc
    
    Returns:
    
    The rule
  - stringType
```
public StringTypeRule stringType()
```
    Matches any String type value
    
    Returns:
    
    The rule
  - booleanType
```
public BooleanTypeRule booleanType()
```
    Matches any Boolean type value
    
    Returns:
    
    The rule
  - string
```
public StringValueRule string(String value)
```
    Matches any value of type string with the specified value
    
    Parameters:
    
    value - The value to match
    
    Returns:
    
    The rule
  - regex
```
public RegexValueRule regex(String pattern)
```
    Matches any value that is accepted by the regex pattern
    
    Parameters:
    
    pattern - The pattern
    
    Returns:
    
    The rule
  - regex
```
public RegexValueRule regex(Pattern pattern)
```
    Matches any value that is accepted by the regex pattern
    
    Parameters:
    
    pattern - The pattern
    
    Returns:
    
    The rule
  - anyOf
```
public AnyOfRule anyOf(Rule... rules)
```
    Matches if any rule matches and suggests all the possibilities.
    
    Parameters:
    
    rules - The option rules
    
    Returns:
    
    The rule
  - anyOf
```
public AnyOfRule anyOf(List<Rule> rules)
```
    Matches if any rule matches and suggests all the possibilities.
    
    Parameters:
    
    rules - The option rules
    
    Returns:
    
    The rule
  - firstOf
```
public AnyOfRule firstOf(Rule... rules)
```
    Accepts if any rule matches and delegates the suggestion to the first one that matches.
    
    Parameters:
    
    rules - The rules
  - not
```
public NegativeRule not(Rule rule)
```
    Matches if the specified rule does not match
    
    Parameters:
    
    rule - The rule to be negated
    
    Returns:
    
    The rule
  - allOf
```
public AllOfRule allOf(Rule... rules)
```
    Matches if all the specified rules matches
    
    Parameters:
    
    rules - All the rules to match
    
    Returns:
    
    The rule
  - optional
```
public AnyOfRule optional(Rule rule)
```
    Matches if the rule matches or the value is null
    
    Parameters:
    
    rule - The rule to match
    
    Returns:
    
    The rule
  - minLength
```
public MinLengthRule minLength(int length)
```
    Matches a string that its length is bigger or equals to the specified
    
    Parameters:
    
    length - The length
    
    Returns:
    
    The rule
  - nullValue
```
protected NullValueRule nullValue()
```
    Matches a null value.
    
    Returns:
    
    The rule
  - when
```
public ConditionalRules when(String expr,
                             ConditionalRule... cases)
```
    It will dispatch the to the conditional rule that matches the selected value. Similar to a pattern matching scenario
    
    Parameters:
    
    expr - The expression to select
    
    cases - The conditional cases
    
    Returns:
    
    The rule
  - when
```
public ConditionalRules when(List<String> expr,
                             ConditionalRule... cases)
```
    It will dispatch the to the conditional rule that matches the selected value. Similar to a pattern matching scenario
    
    Parameters:
    
    expr - The list of expressions to try the first that is not null will be used
    
    cases - The conditional cases
    
    Returns:
    
    The rule
  - is
```
public ConditionalRule is(Rule rule)
```
    Conditional rule that will accept if the rule matches
    
    Parameters:
    
    rule - The rule to be used as matching
    
    Returns:
    
    The rule
  - parentKey
```
public DefaultValue parentKey()
```
    Returns a default value that is the parent key
    
    Returns:
    
    The default value
  - exclusiveKeys
```
public ExclusiveKeys exclusiveKeys(String... keys)
```
    Creates a new set of exclusive rules
    
    Parameters:
    
    keys - Each of the mutually exclusive rules
    
    Returns:
    
    The rule

Class BaseGrammar

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseGrammar

Method Detail

objectType

named

inNewContext

whenChildIs

whenPresent

any

array

integerType

positiveIntegerType

numberType

positiveNumberType

range

integer

field

field

fieldWithRequiredValue

requiredField

scalarType

stringType

booleanType

string

regex

regex

anyOf

anyOf

firstOf

not

allOf

optional

minLength

nullValue

when

when

is

parentKey

exclusiveKeys