AbstractRule (vertigo-commons 3.4.0 API)

java.lang.Object
- io.vertigo.commons.peg.AbstractRule<R,M>

Type Parameters:

R - Type of the product text parsing

M - Type of the parent parsing rule

All Implemented Interfaces:

PegRule<R>
```
public abstract class AbstractRule<R,M>
extends Object
implements PegRule<R>
```
Une règle peut être vue comme - la création d'une règle principale - la gestion du résultat du parsing

Author:

pchretien

Nested Class Summary
- Nested classes/interfaces inherited from interface io.vertigo.commons.peg.PegRule
  PegRule.Dummy

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractRule(PegRule<M> mainRule)

protected AbstractRule(PegRule<M> mainRule, String ruleName)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getExpression()`
`protected PegRule<M>`	`getMainRule()`
`protected String`	`getRuleName()`
`protected abstract R`	`handle(M parsing)`
`PegResult<R>`	`parse(String text, int start)`	Parser produces an object

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

Methods inherited from interface io.vertigo.commons.peg.PegRule
parse

- Constructor Detail
  - AbstractRule
```
protected AbstractRule(PegRule<M> mainRule)
```
  - AbstractRule
```
protected AbstractRule(PegRule<M> mainRule,
                       String ruleName)
```
- Method Detail
  - getMainRule
```
protected final PegRule<M> getMainRule()
```
  - getRuleName
```
protected final String getRuleName()
```
  - getExpression
```
public final String getExpression()
```
    Specified by:
    
    getExpression in interface PegRule<R>
    
    Returns:
    
    Expression de la règle.
  - handle
```
protected abstract R handle(M parsing)
```
  - parse
```
public final PegResult<R> parse(String text,
                                int start)
                         throws PegNoMatchFoundException
```
    Parser produces an object
    or throw an exception. A parser analyzes a text, according some rules. A parser is responsible for moving the index position or throw an exception. Returns the result of the parsing operation.
    
    Specified by:
    
    parse in interface PegRule<R>
    
    Parameters:
    
    text - Text to parse
    
    start - Start of the element of text to parse
    
    Returns:
    
    the new index and the result
    
    Throws:
    
    PegNoMatchFoundException - if parsing has failed.