Package org.apache.maven.doxia.macro

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 java.lang.Object
implements Macro

Abstract base class to execute Macro.

Since:

1.0

Version:

$Id: AbstractMacro.java 1726411 2016-01-23 16:34:09Z hboutemy $

Author:

Jason van Zyl

Field Summary

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

EOL, ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractMacro()

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(java.util.Map<?,?> parameters)	Convert the Map of macro parameters to an AttributeSet.
protected org.apache.maven.doxia.logging.Log	getLog()	Returns a logger for this macro.
protected void	required(java.lang.String paramName, java.lang.String paramValue)	Check if the given parameter is required.

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

execute

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMacro

public AbstractMacro()

Method Detail

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(java.lang.String paramName,
                        java.lang.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(java.util.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.