OptionalExpression (jPicEdt 1.4.1_03 API documentation)

java.lang.Object
- jpicedt.format.input.util.AbstractRegularExpression
- - jpicedt.format.input.util.OptionalExpression

All Implemented Interfaces:

ExpressionConstants
```
public class OptionalExpression
extends AbstractRegularExpression
```
an expression that represents a pattern repeating at most once

Since:

jpicedt 1.3

Version:

$Id: OptionalExpression.java,v 1.4.2.1 2007/09/02 11:56:14 reynal Exp $

Author:

Sylvain Reynal

Field Summary
- Fields inherited from interface jpicedt.format.input.util.ExpressionConstants
  ANY_CHAR, ANY_CHAR_EOL, ANY_SIGN, AT_LEAST, AT_MOST, DEBUG, DOUBLE, EOL, EXACTLY, INTEGER, NEGATIVE, NON_NULL, POSITIVE, STRICTLY_NEGATIVE, STRICTLY_POSITIVE, WHITE_SPACES, WHITE_SPACES_OR_EOL

Constructor Summary

Constructors
Constructor Description

OptionalExpression(AbstractRegularExpression expr)
the expression to be matched (yet optionally)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`interpret(Context c)`	Parses this expression, possibly using the given Context to fetch the String to interpret if this Expression is a leaf expression.
`java.lang.String`	`toString()`

Methods inherited from class jpicedt.format.input.util.AbstractRegularExpression
action

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

- Constructor Detail
  - OptionalExpression
```
public OptionalExpression(AbstractRegularExpression expr)
```
    the expression to be matched (yet optionally)
- Method Detail
  - interpret
```
public boolean interpret(Context c)
                  throws REParserException
```
    Description copied from class: AbstractRegularExpression
    
    Parses this expression, possibly using the given Context to fetch the String to interpret if this Expression is a leaf expression.
    
    Specified by:
    
    interpret in class AbstractRegularExpression
    
    Returns:
    
    TRUE in any case since this expression is... optional !
    
    Throws:
    
    REParserException - if an error occur during parsing
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object