Package org.apache.maven.doxia.siterenderer

## Class RenderingContext

- java.lang.Object
- - org.apache.maven.doxia.sink.render.RenderingContext
  - - org.apache.maven.doxia.siterenderer.RenderingContext

    public class RenderingContext
    extends org.apache.maven.doxia.sink.render.RenderingContext

The rendering context of a document.

Since:
  1.5 (was since 1.1 in o.a.m.d.sink.render)
Version:
  $Id: RenderingContext.java 1720929 2015-12-19 14:09:41Z hboutemy $
Author:
  Jason van Zyl

### Constructor Summary

Constructors
`RenderingContext​(java.io.File basedir, java.lang.String document)` Constructor for RenderingContext when document is not rendered from a Doxia source.
`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
`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 when document is not rendered from a Doxia source.

Parameters:
  `basedir` - the pseudo-source base directory.
  `document` - the pseudo-source document name: will be used to compute output name (same name with extension replaced with `.html`).

#### RenderingContext

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

Constructor for RenderingContext.

Parameters:
  `basedir` - the source base directory.
  `document` - the source document name.
  `parserId` - the Doxia module parser id associated to this document, may be null if document not rendered from a Doxia source.
  `extension` - the source document filename extension.

### Method Detail

#### getBasedir

    public java.io.File getBasedir()

Getter for the field `basedir`.

Overrides:
  `getBasedir` in class `org.apache.maven.doxia.sink.render.RenderingContext`
Returns:
  a `File` object.

#### getInputName

    public java.lang.String getInputName()

Getter for the field `inputName`.

Overrides:
  `getInputName` in class `org.apache.maven.doxia.sink.render.RenderingContext`
Returns:
  a `String` object.

#### getOutputName

    public java.lang.String getOutputName()

Getter for the field `outputName`.

Overrides:
  `getOutputName` in class `org.apache.maven.doxia.sink.render.RenderingContext`
Returns:
  a `String` object.

#### getParserId

    public java.lang.String getParserId()

Getter for the field `parserId`.

Overrides:
  `getParserId` in class `org.apache.maven.doxia.sink.render.RenderingContext`
Returns:
  a `String` object.

#### getRelativePath

    public java.lang.String getRelativePath()

Getter for the field `relativePath`.

Overrides:
  `getRelativePath` in class `org.apache.maven.doxia.sink.render.RenderingContext`
Returns:
  a `String` object.

#### setAttribute

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

setAttribute.

Overrides:
  `setAttribute` in class `org.apache.maven.doxia.sink.render.RenderingContext`
Parameters:
  `key` - a `String` object.
  `value` - a `String` object.

#### getAttribute

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

getAttribute.

Overrides:
  `getAttribute` in class `org.apache.maven.doxia.sink.render.RenderingContext`
Parameters:
  `key` - a `String` object.
Returns:
  a `String` object.

#### getExtension

    public java.lang.String getExtension()

Getter for the field `extension`.

Overrides:
  `getExtension` in class `org.apache.maven.doxia.sink.render.RenderingContext`
Returns:
  a `String` object.