All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.event.MacroParseEvent

java.lang.Object
   |
   +----java.util.EventObject
           |
           +----com.ibm.eNetwork.beans.HOD.event.HODEvent
                   |
                   +----com.ibm.eNetwork.beans.HOD.event.MacroParseEvent

public class MacroParseEvent
extends HODEvent
Event fired to objects implementing the MacroParseListener interface. this event can be used to discover the details of any syntax errors that the Macro bean finds in a macro string or stream.

To use this class properly, follow these steps:

  1. Implement the MacroParseListener and add it to Macro using Macro.addMacroParseListener.
  2. If the parseFailed method is called, you will know the syntax is incorrect.
  3. Call the parseStats() method to get an enumeration of all the problems with the macro.
  4. Using the MacroParseStat object, you can get the line number, line text, and error message of each error in the file.


Constructor Index

 o MacroParseEvent(Macro)
Constructs a parse event with Macro as its source.

Method Index

 o isSuccess()
Returns if the parsing was successful.
 o parseStats()
Returns the parse statistics enumeration for the parse.

Constructors

 o MacroParseEvent
 public MacroParseEvent(Macro m)
Constructs a parse event with Macro as its source.

Parameters:
m - Macro object that is source of parse event

Methods

 o isSuccess
 public boolean isSuccess()
Returns if the parsing was successful. Since the event is passed only on the parseFaild method, this should always be false.

Returns:
success state of the parse
 o parseStats
 public Enumeration parseStats()
Returns the parse statistics enumeration for the parse. Any and all errors are described in the enumeration.

Returns:
parsing statistic enumeration

All Packages  Class Hierarchy  This Package  Previous  Next  Index