Package org.apache.maven.doxia.macro
Class MacroRequest
java.lang.Object
org.apache.maven.doxia.macro.MacroRequest
MacroRequest class.
- Since:
- 1.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionMacroRequest
(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 TypeMethodDescriptionReturns the current base directory.getParameter
(String key) Returns on object from the map of parameters that corresponds to the given key.Returns the map of parameters.getParser.getSourceContent.static boolean
isInternalParameter
(String name) isInternalParameter.void
setBasedir
(File base) Sets the current base directory.
-
Field Details
-
PARAM_SOURCE_CONTENT
- See Also:
-
PARAM_PARSER
- See Also:
-
basedir
The current base directory. -
parameters
A map of parameters.
-
-
Constructor Details
-
MacroRequest
Deprecated.prefer other constructorConstructor.- 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
- aString
object.parser
- aAbstractParser
object.param
- aMap
object.base
- aFile
object.
-
-
Method Details
-
getBasedir
Returns the current base directory.- Returns:
- The base dir.
-
setBasedir
Sets the current base directory.- Parameters:
base
- The current base directory.
-
getParameters
Returns the map of parameters.- Returns:
- The map of parameters.
-
getParameter
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
getSourceContent.
- Returns:
- a
String
object.
-
getParser
getParser.
- Returns:
- a
Parser
object.
-
isInternalParameter
isInternalParameter.
- Parameters:
name
- aString
object.- Returns:
- a boolean.
-