com.martiansoftware.snip.util
Interface MacroProcessor

All Known Implementing Classes:

RunSnip

public interface MacroProcessor

Marks a class as capable of expanding macros.

Author:

Marty Lamb

Method Summary

java.lang.String

processMacro(java.lang.String macro) Processes a macro.

Method Detail

processMacro

public java.lang.String processMacro(java.lang.String macro)
                              throws MacroException

Processes a macro.

Parameters:

macro - the macro to process, excluding the macroBegin and macroEnd delimiters (i.e., if the macro is "${TEST}", this parameter will contain the String "TEST").

Returns:

the evaluated value of the macro, or null if the macro cannot be processed.

Throws:

MacroException - if it has any reason to complain.