Package org.apache.maven.doxia.macro

Class MacroRequest

  • public class MacroRequest
extends java.lang.Object

    MacroRequest class.

    Since:
    1.0
    Author:
    Jason van Zyl

    • Constructor Summary

      Constructors 
      Constructor Description
      MacroRequest​(java.lang.String sourceContent, AbstractParser parser, java.util.Map<java.lang.String,​java.lang.Object> param, java.io.File basedir)
      Constructor for MacroRequest.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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()
      getParser.
      java.lang.String getSourceContent()
      getSourceContent.
      static boolean isInternalParameter​(java.lang.String name)
      isInternalParameter.
      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.lang.String sourceContent,
                    AbstractParser parser,
                    java.util.Map<java.lang.String,​java.lang.Object> param,
                    java.io.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 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()

        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​(java.lang.String name)

        isInternalParameter.

        Parameters:
        name - a String object.
        Returns:
        a boolean.