|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpmp.Macroprocessor.Component
pmp.MacroList
public class MacroList
Maintains list of macros.
Title: PMP: Macroprocessor
Description: Java macroprocessor
Copyright: Copyright (c) 2005
Field Summary | |
---|---|
protected java.util.Map<java.lang.String,MacroListItem> |
macros
list of macros |
protected java.util.List<MacroListModifyListener> |
modifyListeners
list of listeners for macro changes |
Constructor Summary | |
---|---|
MacroList(Macroprocessor mp)
|
Method Summary | |
---|---|
boolean |
addAll(java.util.Map<java.lang.String,AbstractMacro> m)
Add all macros from given Map to this MacroList. |
void |
addModifyListener(MacroListModifyListener listener)
Adds new listener for macro list modification events. |
void |
clear(boolean all)
Removes all macro definitions. |
boolean |
copyMacro(java.lang.String srcName,
java.lang.String destName)
Copies macro. |
java.lang.String |
forName(java.lang.String var)
Returns name of configuration directive for given name. |
java.lang.String |
forName(java.lang.String var,
java.lang.String id)
Returns name of configuration directive for given template and id. |
java.util.Map<java.lang.String,AbstractMacro> |
getAll()
Returns map with all defined macros. |
boolean |
getBool(java.lang.String directive)
Returns boolean value associated with given directive name. |
boolean |
getBool(java.lang.String template,
java.lang.String id)
Returns boolean value associated with given directive name. |
java.lang.String[] |
getIDsByMask(java.lang.String mask)
Returns array of indices for given mask. |
int |
getInt(java.lang.String directive)
Returns integer value associated with given directive name. |
int |
getInt(java.lang.String template,
java.lang.String id)
Returns integer value associated with given directive name. |
AbstractMacro |
getMacro(java.lang.String macroName)
Returns macro object assicated with given name. |
AbstractMacro |
getMacroCI(java.lang.String macroName)
Returns macro object assicated with given name. |
java.lang.String[] |
getMacroNames()
Returns array of macro names. |
java.lang.String |
getString(java.lang.String directive)
Returns configuration directive as string value. |
java.lang.String |
getString(java.lang.String directive_template,
java.lang.String id)
Returns configuration directive as string value. |
java.lang.String |
getStringL(java.lang.String directive)
Returns result of getString(String) after being converted to
lower-case. |
java.lang.String |
getStringL(java.lang.String directive_template,
java.lang.String id)
Returns result of getString(String) after being converted to
lower-case. |
boolean |
isDefined(java.lang.String macroName)
Returns true if macro with specified name exists. |
boolean |
isDirectiveDefined(java.lang.String directive)
Returns true when specified directive is defined. |
boolean |
isDirectiveDefined(java.lang.String template,
java.lang.String id)
Returns true when specified directive is defined. |
boolean |
isReadOnly(java.lang.String macroName)
Returns true if macro is marked as read-only. |
java.util.Iterator<java.lang.String> |
macroIterator()
Returns read-only iterator over macro names. |
AbstractMacro |
popMacro(java.lang.String macroName)
Restores previous macro definition and returns previous one. |
void |
pushMacro(java.lang.String macroName,
AbstractMacro macro)
Replaces current macro definition with new one and stores previous one to definition stack. |
void |
removeModifyListeners()
Removes all listeners. |
AbstractMacro |
setMacro(java.lang.String macroName,
AbstractMacro macro)
Defines macro. |
AbstractMacro |
setMacro(java.lang.String macroName,
java.lang.String macro)
Adds new user-defined macro. |
AbstractMacro |
setMacroForName(java.lang.String directive,
AbstractMacro macro)
Defines macro. |
AbstractMacro |
setMacroForName(java.lang.String directive,
java.lang.String macro)
Defines macro. |
AbstractMacro |
unsetMacro(java.lang.String macroName)
Removes macro definition by calling setMacro(String,AbstractMacro) for given macroName
with null as macro definition. |
Methods inherited from class pmp.Macroprocessor.Component |
---|
error, getMP, getMPAnalyzer, getMPIO, getMPIQ, getMPMacros, notice, warning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.Map<java.lang.String,MacroListItem> macros
protected java.util.List<MacroListModifyListener> modifyListeners
Constructor Detail |
---|
public MacroList(Macroprocessor mp)
Method Detail |
---|
public void addModifyListener(MacroListModifyListener listener)
listener
- new listenerpublic void removeModifyListeners()
public AbstractMacro getMacro(java.lang.String macroName)
macroName
- name of macro
public AbstractMacro getMacroCI(java.lang.String macroName)
macroName
- name of macro
public void clear(boolean all)
all
- if true
read-only macros will be removed as wellpublic AbstractMacro unsetMacro(java.lang.String macroName)
setMacro(String,AbstractMacro)
for given macroName
with null
as macro definition.
macroName
- name of macro to be removed
public boolean copyMacro(java.lang.String srcName, java.lang.String destName)
Prints warning on failure (read-only macro or missing source macro).
srcName
- source macrodestName
- destination name
true
if everything is okpublic AbstractMacro setMacro(java.lang.String macroName, java.lang.String macro)
DefinedMacro
class and calls setMacro(String,AbstractMacro)
macroName
- name of macromacro
- definition of macro
setMacro(String,AbstractMacro)
public AbstractMacro setMacro(java.lang.String macroName, AbstractMacro macro)
macroName
- name of macromacro
- definition of macro
public boolean addAll(java.util.Map<java.lang.String,AbstractMacro> m)
m
- Map
with macro definitions
true
public java.util.Map<java.lang.String,AbstractMacro> getAll()
public void pushMacro(java.lang.String macroName, AbstractMacro macro)
macroName
- name of macromacro
- new definitionpublic AbstractMacro popMacro(java.lang.String macroName)
macroName
- name of macro
public boolean isDirectiveDefined(java.lang.String directive)
true
when specified directive is defined.
directive
- name of directive (without prefix)
true
if is definedpublic boolean isDirectiveDefined(java.lang.String template, java.lang.String id)
true
when specified directive is defined.
template
- template for name of directive (without prefix)id
- identifier of directive
true
if is definedpublic boolean isDefined(java.lang.String macroName)
true
if macro with specified name exists.
macroName
- nema of macro
true
if macro existspublic boolean isReadOnly(java.lang.String macroName)
true
if macro is marked as read-only. If macro
doesn't exists, false
is returned.
macroName
- name of macro
true
if macro exists and is marked as read-only.public java.lang.String forName(java.lang.String var)
var
- name of directive name (typicaly obained from static field of
ConfigDirectives
class)
public java.lang.String forName(java.lang.String var, java.lang.String id)
var
- template for directive name (typically obained from static
field of ConfigDirectives
class)id
- identifier
public AbstractMacro setMacroForName(java.lang.String directive, AbstractMacro macro)
directive
with prependef prefix.
directive
- Name of configuration directivemacro
- macro object
setMacro(String, AbstractMacro)
setMacro(String, String)
,
forName(String)
public AbstractMacro setMacroForName(java.lang.String directive, java.lang.String macro)
directive
with prependef prefix.
directive
- Name of configuration directivemacro
- macro definition
setMacro(String, String)
setMacro(String, String)
,
forName(String)
public java.lang.String getString(java.lang.String directive)
forName(String)
.
Return value is obtained by calling macro's toString method
Returns ""
when given directive is not defined.
directive
- name of configuration directive
AbstractMacro.toString()
public java.lang.String getString(java.lang.String directive_template, java.lang.String id)
forName(String,String)
.
Returns ""
when given directive is not defined.
directive_template
- template for name of configuration directiveid
- identifier part of configuration directive
public java.lang.String getStringL(java.lang.String directive)
getString(String)
after being converted to
lower-case.
directive
- name of configuration directive
public java.lang.String getStringL(java.lang.String directive_template, java.lang.String id)
getString(String)
after being converted to
lower-case.
directive_template
- temlate for name of configuration directiveid
- identifier of configuration directive
public boolean getBool(java.lang.String directive)
true
except strings: "off",
"false", "no", "0" (case-insensitively)
directive
- name of configuration directive
public boolean getBool(java.lang.String template, java.lang.String id)
true
except strings: "off",
"false", "no", "0" (case-insensitively)
template
- tempate for name of configuration directiveid
- identifier of directive
forName(String,String)
public int getInt(java.lang.String directive)
directive
- name of configuration directive
public int getInt(java.lang.String template, java.lang.String id)
template
- tempate for name of configuration directiveid
- identifier of directive
public java.lang.String[] getIDsByMask(java.lang.String mask)
Note: Identifier containing character '.' (\u002e) will not be found.
mask
- mask (without prefix)
public java.lang.String[] getMacroNames()
public java.util.Iterator<java.lang.String> macroIterator()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |