Class AbstractMacro

java.lang.Object
org.apache.maven.doxia.macro.AbstractMacro
All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled, Macro
Direct Known Subclasses:
EchoMacro, SnippetMacro, SsiMacro, SwfMacro, TocMacro

public abstract class AbstractMacro extends Object implements Macro
Abstract base class to execute Macro.
Since:
1.0
Author:
Jason van Zyl
  • Field Summary

    Fields inherited from interface org.apache.maven.doxia.macro.Macro

    EOL, ROLE
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    enableLogging(org.apache.maven.doxia.logging.Log log)
    protected static org.apache.maven.doxia.sink.SinkEventAttributes
    getAttributesFromMap(Map<?,?> parameters)
    Convert the Map of macro parameters to an AttributeSet.
    protected org.apache.maven.doxia.logging.Log
    Returns a logger for this macro.
    protected void
    required(String paramName, String paramValue)
    Check if the given parameter is required.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.maven.doxia.macro.Macro

    execute
  • Constructor Details

    • AbstractMacro

      public AbstractMacro()
  • Method Details

    • enableLogging

      public void enableLogging(org.apache.maven.doxia.logging.Log log)
      Specified by:
      enableLogging in interface org.apache.maven.doxia.logging.LogEnabled
    • getLog

      protected org.apache.maven.doxia.logging.Log getLog()
      Returns a logger for this macro. If no logger has been configured, a new SystemStreamLog is returned.
      Returns:
      Log
      Since:
      1.1
    • required

      protected void required(String paramName, String paramValue)
      Check if the given parameter is required. Throws an IllegalArgumentException if paramValue is null or empty.
      Parameters:
      paramName - The name of the parameter to check.
      paramValue - The parameter value.
      Since:
      1.1
    • getAttributesFromMap

      protected static org.apache.maven.doxia.sink.SinkEventAttributes getAttributesFromMap(Map<?,?> parameters)
      Convert the Map of macro parameters to an AttributeSet. No check of validity is done, all parameters are added.
      Parameters:
      parameters - the macro parameters.
      Returns:
      a SinkEventAttributeSet containing the same parameters, or null if parameters is null.
      Since:
      1.1.1.