Class MacroRequest

java.lang.Object

org.apache.maven.doxia.macro.MacroRequest

public class MacroRequest
extends Object

MacroRequest class.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private File	basedir	The current base directory.
private static final String	PARAM_PARSER
private static final String	PARAM_SOURCE_CONTENT
private Map<String,Object>	parameters	A map of parameters.

Constructor Summary

Constructors

Constructor	Description
MacroRequest(String sourceContent, AbstractParser parser, Map<String,Object> param, File basedir)	Constructor for MacroRequest.

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 Object

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

Field Details

PARAM_SOURCE_CONTENT

private static final String PARAM_SOURCE_CONTENT

See Also:

• Constant Field Values

PARAM_PARSER

private static final String PARAM_PARSER

See Also:

• Constant Field Values

basedir

private File basedir

The current base directory.

parameters

private Map<String,Object> parameters

A map of parameters.

Constructor Details

MacroRequest

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

Constructor for MacroRequest.

Parameters:

sourceContent - a String object.

parser - a new AbstractParser object acting as secondary parser.

param - a Map object.

basedir - a File object.

Method Details

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. This is a new secondary parser.

isInternalParameter

public static boolean isInternalParameter(String name)

isInternalParameter.

Parameters:

name - a String object.

Returns:

a boolean.