ParserProcedure (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractParserProcedure, Println
```
public interface ParserProcedure
extends Serializable
```
Interface for procedures to be used in parsers. Procedures must be stateless, as only a single instance is kept in memory.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`callProcedure(Object[] params)`	Gets called from the parser.
`String`	`getProcedureHelp()`	Returns the help string for the procedure.
`String`	`getProcedureName()`	Returns the name of the procedure.
`String`	`getProcedureSignature()`	Returns the signature of the procedure.

- Method Detail
  - getProcedureName
```
String getProcedureName()
```
    Returns the name of the procedure. Can only consist of letters, underscores, numbers.
    
    Returns:
    
    the name
  - getProcedureSignature
```
String getProcedureSignature()
```
    Returns the signature of the procedure.
    
    Returns:
    
    the signature
  - getProcedureHelp
```
String getProcedureHelp()
```
    Returns the help string for the procedure.
    
    Returns:
    
    the help string
  - callProcedure
```
void callProcedure(Object[] params)
```
    Gets called from the parser.
    
    Parameters:
    
    params - the parameters obtained through the parser