com.dfamaj.textproc.xwm
Class XwmMacroDefinition

java.lang.Object
  com.dfamaj.textproc.xwm.XwmMacroDefinition

All Implemented Interfaces:

ThreadUnsafe, java.io.Serializable

Direct Known Subclasses:

XwmPrimitive

public class XwmMacroDefinition
extends java.lang.Object
implements ThreadUnsafe, java.io.Serializable

définition d'une macro.

Since:

2.0

Version:

2.0 -- 2007-02-01 -- $Revision$

Author:

David Andriana

See Also:

Serialized Form

Constructor Summary

	XwmMacroDefinition() constructeur.
protected	XwmMacroDefinition(boolean isNoExpand) constructeur.

Method Summary

int	addParam(Location location, java.lang.String param) rajoute un paramètre nommé à la macro.
void	addParamOutput(int param) rajoute une substitution de paramètre à la macro.
void	addTokenOutput(Token token) rajoute une sortie à la macro.
java.util.Iterator	getOutputTokens() renvoie un itérateur sur les tokens de sortie.
int	getParamCount() renvoie le nombre de paramètres de cette macro.
int	getParamIndex(Location location, java.lang.String param) renvoie l'index qui correspond à un paramètre dans la définition de la macro.
java.lang.String	getParamName(int paramIndex) renvoie le nom d'un certain paramètre dans la définition de la macro.
com.dfamaj.textproc.xwm.ParamSeparator	getParamSeparator(int paramIndex) renvoie le séparateur d'un certain paramètre dans la définition de la macro.
void	setParamSeparator(int paramIndex, Token separatorToken) fixe le séparateur d'un paramètre donné dans la définition de la macro.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XwmMacroDefinition

public XwmMacroDefinition()

constructeur.

XwmMacroDefinition

protected XwmMacroDefinition(boolean isNoExpand)

constructeur.

Method Detail

addParam

public int addParam(Location location,
                    java.lang.String param)
             throws DuplicateParamException

rajoute un paramètre nommé à la macro. Renvoie l'index du paramètre ainsi ajouté.

Throws:

DuplicateParamException

addParamOutput

public void addParamOutput(int param)

rajoute une substitution de paramètre à la macro.

addTokenOutput

public void addTokenOutput(Token token)

rajoute une sortie à la macro.

getOutputTokens

public java.util.Iterator getOutputTokens()

renvoie un itérateur sur les tokens de sortie.
Type des objets : Token

getParamCount

public int getParamCount()

renvoie le nombre de paramètres de cette macro.

getParamIndex

public int getParamIndex(Location location,
                         java.lang.String param)
                  throws UnknownParamException

renvoie l'index qui correspond à un paramètre dans la définition de la macro. Le premier paramètre aura l'index 0 (zéro), etc. Si le paramètre n'existe pas, lève une UnknownParamException.

Throws:

UnknownParamException

getParamName

public java.lang.String getParamName(int paramIndex)

renvoie le nom d'un certain paramètre dans la définition de la macro.

getParamSeparator

public com.dfamaj.textproc.xwm.ParamSeparator getParamSeparator(int paramIndex)

renvoie le séparateur d'un certain paramètre dans la définition de la macro.

setParamSeparator

public void setParamSeparator(int paramIndex,
                              Token separatorToken)

fixe le séparateur d'un paramètre donné dans la définition de la macro.