pmp
Class MacroListItem

java.lang.Object
  extended by pmp.MacroListItem

public class MacroListItem
extends java.lang.Object

Element of list of macros. Encapsules definition of macro, definition stack, and attributes.

Title: PMP: Macroprocessor

Description: Java macroprocessor

Copyright: Copyright (c) 2005

Version:
1.0
Author:
Luděk Hlaváček
To Do:
make use of executable flag

Constructor Summary
MacroListItem(AbstractMacro def, boolean readOnly)
          Convenience constructor
MacroListItem(AbstractMacro def, java.util.Collection<AbstractMacro> stack)
          Conveninece constructor.
MacroListItem(AbstractMacro def, java.util.Collection<AbstractMacro> stack, boolean readOnly, boolean executable)
          Main constructor.
 
Method Summary
 MacroListItem duplicate()
          Returns new instance of MacroListItem with identical contents as this object.
 AbstractMacro getDefinition()
          Returns current macro definition.
 boolean getExecutableFlag()
           
 boolean getReadOnlyFlag()
           
 boolean isReadOnly()
          Returns true if this definition is immutable.
 AbstractMacro popDef()
           
 void pushDef(AbstractMacro macro)
          Replaces current macro definition and saves current definition to stack.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MacroListItem

public MacroListItem(AbstractMacro def,
                     java.util.Collection<AbstractMacro> stack)
Conveninece constructor.

Parameters:
def - macro definition object
stack - macro definition history

MacroListItem

public MacroListItem(AbstractMacro def,
                     boolean readOnly)
Convenience constructor

Parameters:
def - macro definition
readOnly - read-only flag

MacroListItem

public MacroListItem(AbstractMacro def,
                     java.util.Collection<AbstractMacro> stack,
                     boolean readOnly,
                     boolean executable)
Main constructor.

Parameters:
def - macro definition object
stack - definition history
readOnly - read-only flag
Method Detail

duplicate

public MacroListItem duplicate()
Returns new instance of MacroListItem with identical contents as this object.

Returns:
copy of this object

getDefinition

public AbstractMacro getDefinition()
Returns current macro definition.

Returns:
macro object

getExecutableFlag

public boolean getExecutableFlag()

getReadOnlyFlag

public boolean getReadOnlyFlag()

pushDef

public void pushDef(AbstractMacro macro)
Replaces current macro definition and saves current definition to stack.

Parameters:
macro - new definition

popDef

public AbstractMacro popDef()

isReadOnly

public boolean isReadOnly()
Returns true if this definition is immutable.

Returns:
state of read-only flag