org.apache.maven.doxia.macro
Class MacroRequest

java.lang.Object
  extended by org.apache.maven.doxia.macro.MacroRequest

public class MacroRequest
extends java.lang.Object

Since:
1.0
Version:
$Id: MacroRequest.java 567311 2007-08-18 18:30:54Z vsiveton $
Author:
Jason van Zyl

Constructor Summary
MacroRequest(java.util.Map param, java.io.File base)
          Constructor.
 
Method Summary
 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 getParameters()
          Returns the map of parameters.
 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
 

Constructor Detail

MacroRequest

public MacroRequest(java.util.Map param,
                    java.io.File base)
Constructor.

Parameters:
param - A map of parameters.
base - The current base directory.
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 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.


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.