Package org.apache.maven.doxia.sink.render

Class RenderingContext

  • public class RenderingContext
extends java.lang.Object
    The rendering context of a document.
    Since:
    1.1
    Version:
    $Id: RenderingContext.java 1090706 2011-04-09 23:15:28Z hboutemy $
    Author:
    Jason van Zyl

    • Constructor Summary

      Constructors 
      Constructor Description
      RenderingContext​(java.io.File basedir, java.lang.String document)
      Constructor for RenderingContext.
      RenderingContext​(java.io.File basedir, java.lang.String document, java.lang.String parserId)
      Constructor for RenderingContext.
      RenderingContext​(java.io.File basedir, java.lang.String document, java.lang.String parserId, java.lang.String extension)
      Constructor for RenderingContext.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAttribute​(java.lang.String key)
      getAttribute.
      java.io.File getBasedir()
      Getter for the field basedir.
      java.lang.String getExtension()
      Getter for the field extension.
      java.lang.String getInputName()
      Getter for the field inputName.
      java.lang.String getOutputName()
      Getter for the field outputName.
      java.lang.String getParserId()
      Getter for the field parserId.
      java.lang.String getRelativePath()
      Getter for the field relativePath.
      void setAttribute​(java.lang.String key, java.lang.String value)
      setAttribute.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RenderingContext

        public RenderingContext​(java.io.File basedir,
                        java.lang.String document)

        Constructor for RenderingContext.

        Parameters:
        basedir - a File object.
        document - a String object.

      • RenderingContext

        public RenderingContext​(java.io.File basedir,
                        java.lang.String document,
                        java.lang.String parserId)

        Constructor for RenderingContext.

        Parameters:
        basedir - a File object.
        document - a String object.
        parserId - a String object.

      • RenderingContext

        public RenderingContext​(java.io.File basedir,
                        java.lang.String document,
                        java.lang.String parserId,
                        java.lang.String extension)

        Constructor for RenderingContext.

        Parameters:
        basedir - a File object.
        document - a String object.
        parserId - a String object.
        extension - a String object.

    • Method Detail

      • getBasedir

        public java.io.File getBasedir()

        Getter for the field basedir.

        Returns:
        a File object.

      • getInputName

        public java.lang.String getInputName()

        Getter for the field inputName.

        Returns:
        a String object.

      • getOutputName

        public java.lang.String getOutputName()

        Getter for the field outputName.

        Returns:
        a String object.

      • getParserId

        public java.lang.String getParserId()

        Getter for the field parserId.

        Returns:
        a String object.

      • getRelativePath

        public java.lang.String getRelativePath()

        Getter for the field relativePath.

        Returns:
        a String object.

      • setAttribute

        public void setAttribute​(java.lang.String key,
                         java.lang.String value)

        setAttribute.

        Parameters:
        key - a String object.
        value - a String object.

      • getAttribute

        public java.lang.String getAttribute​(java.lang.String key)

        getAttribute.

        Parameters:
        key - a String object.
        Returns:
        a String object.

      • getExtension

        public java.lang.String getExtension()

        Getter for the field extension.

        Returns:
        a String object.