org.apache.maven.doxia.macro

Class MacroRequest

java.lang.Object

org.apache.maven.doxia.macro.MacroRequest

public class MacroRequest
extends java.lang.Object

MacroRequest class.

Since:

1.0

Version:

$Id: MacroRequest.java 1728197 2016-02-02 19:52:10Z hboutemy $

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MacroRequest(java.util.Map<java.lang.String,java.lang.Object> param, java.io.File base) Deprecated. prefer other constructor
MacroRequest(java.lang.String sourceContent, AbstractParser parser, java.util.Map<java.lang.String,java.lang.Object> param, java.io.File base)

Method Summary

Modifier and Type	Method and Description
java.io.File	getBasedir() Returns the current base directory.
java.lang.Object	getParameter(java.lang.String key) Returns on object from the map of parameters that corresponds to the given key.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Returns the map of parameters.
Parser	getParser()
java.lang.String	getSourceContent()
static boolean	isInternalParameter(java.lang.String name)
void	setBasedir(java.io.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

Field Detail

PARAM_SOURCE_CONTENT

private static final java.lang.String PARAM_SOURCE_CONTENT

See Also:

Constant Field Values

PARAM_PARSER

private static final java.lang.String PARAM_PARSER

See Also:

Constant Field Values

basedir

private java.io.File basedir

The current base directory.

parameters

private java.util.Map<java.lang.String,java.lang.Object> parameters

A map of parameters.

Constructor Detail

MacroRequest

public MacroRequest(java.util.Map<java.lang.String,java.lang.Object> param,
                    java.io.File base)

Deprecated. prefer other constructor

Constructor.

Parameters:

param - A map of parameters.

base - The current base directory.

MacroRequest

public MacroRequest(java.lang.String sourceContent,
                    AbstractParser parser,
                    java.util.Map<java.lang.String,java.lang.Object> param,
                    java.io.File base)

Method Detail

getBasedir

public java.io.File getBasedir()

Returns the current base directory.

Returns:

The base dir.

setBasedir

public void setBasedir(java.io.File base)

Sets the current base directory.

Parameters:

base - The current base directory.

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Returns the map of parameters.

Returns:

The map of parameters.

getParameter

public java.lang.Object getParameter(java.lang.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 java.lang.String getSourceContent()

getParser

public Parser getParser()

isInternalParameter

public static boolean isInternalParameter(java.lang.String name)