PegWordRule (vertigo-commons 3.4.0 API)

java.lang.Object
- io.vertigo.commons.peg.PegWordRule

All Implemented Interfaces:

PegRule<String>
```
public final class PegWordRule
extends Object
implements PegRule<String>
```
Règle a état permettant de récupérer un mot. En précisant : - Soit les caractères acceptés, - Soit les caractères rejetés.

Author:

pchretien

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PegWordRule.Mode
Mode de selection des caractères.
- Nested classes/interfaces inherited from interface io.vertigo.commons.peg.PegRule
  PegRule.Dummy

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getExpression()`
`PegResult<String>`	`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

- Method Detail
  - getExpression
```
public String getExpression()
```
    Specified by:
    
    getExpression in interface PegRule<String>
    
    Returns:
    
    Expression de la règle.
  - parse
```
public PegResult<String> 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<String>
    
    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.