Package org.apache.maven.doxia.macro

Class MacroRequest

java.lang.Object

org.apache.maven.doxia.macro.MacroRequest

public class MacroRequest
extends Object

MacroRequest class.

Since:

1.0

Author:

Jason van Zyl

Constructor Summary

Constructors

Constructor	Description
MacroRequest(String sourceContent, AbstractParser parser, Map<String,Object> param, File base)	Constructor for MacroRequest.
MacroRequest(Map<String,Object> param, File base)	Deprecated. prefer other constructor

Method Summary

Modifier and Type	Method	Description
File	getBasedir()	Returns the current base directory.
Object	getParameter(String key)	Returns on object from the map of parameters that corresponds to the given key.
Map<String,Object>	getParameters()	Returns the map of parameters.
Parser	getParser()	getParser.
String	getSourceContent()	getSourceContent.
static boolean	isInternalParameter(String name)	isInternalParameter.
void	setBasedir(File base)	Sets the current base directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroRequest

public MacroRequest(Map<String,Object> param,
                    File base)

Deprecated.

prefer other constructor

Constructor.

Parameters:

param - A map of parameters.

base - The current base directory.

MacroRequest

public MacroRequest(String sourceContent,
                    AbstractParser parser,
                    Map<String,Object> param,
                    File base)

Constructor for MacroRequest.

Parameters:

sourceContent - a String object.

parser - a AbstractParser object.

param - a Map object.

base - a File object.

Method Detail

getBasedir

public File getBasedir()

Returns the current base directory.

Returns:

The base dir.

setBasedir

public void setBasedir(File base)

Sets the current base directory.

Parameters:

base - The current base directory.

getParameters

public Map<String,Object> getParameters()

Returns the map of parameters.

Returns:

The map of parameters.

getParameter

public Object getParameter(String key)

Returns on object from the map of parameters that corresponds to the given key.

Parameters:

key - The key to lookup the object.

Returns:

The value object.

getSourceContent

public String getSourceContent()

getSourceContent.

Returns:

a String object.

getParser

public Parser getParser()

getParser.

Returns:

a Parser object.

isInternalParameter

public static boolean isInternalParameter(String name)

isInternalParameter.

Parameters:

name - a String object.

Returns:

a boolean.