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 Constructor Description 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 Modifier and Type Method Description java.lang.String
getAttribute(java.lang.String key)
getAttribute.java.io.File
getBasedir()
Getter for the fieldbasedir
.java.lang.String
getExtension()
Getter for the fieldextension
.java.lang.String
getInputName()
Getter for the fieldinputName
.java.lang.String
getOutputName()
Getter for the fieldoutputName
.java.lang.String
getParserId()
Getter for the fieldparserId
.java.lang.String
getRelativePath()
Getter for the fieldrelativePath
.void
setAttribute(java.lang.String key, java.lang.String value)
setAttribute.
-
-
-
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 classorg.apache.maven.doxia.sink.render.RenderingContext
- Returns:
- a
File
object.
-
getInputName
public java.lang.String getInputName()
Getter for the field
inputName
.- Overrides:
getInputName
in classorg.apache.maven.doxia.sink.render.RenderingContext
- Returns:
- a
String
object.
-
getOutputName
public java.lang.String getOutputName()
Getter for the field
outputName
.- Overrides:
getOutputName
in classorg.apache.maven.doxia.sink.render.RenderingContext
- Returns:
- a
String
object.
-
getParserId
public java.lang.String getParserId()
Getter for the field
parserId
.- Overrides:
getParserId
in classorg.apache.maven.doxia.sink.render.RenderingContext
- Returns:
- a
String
object.
-
getRelativePath
public java.lang.String getRelativePath()
Getter for the field
relativePath
.- Overrides:
getRelativePath
in classorg.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 classorg.apache.maven.doxia.sink.render.RenderingContext
- Parameters:
key
- aString
object.value
- aString
object.
-
getAttribute
public java.lang.String getAttribute(java.lang.String key)
getAttribute.
- Overrides:
getAttribute
in classorg.apache.maven.doxia.sink.render.RenderingContext
- Parameters:
key
- aString
object.- Returns:
- a
String
object.
-
getExtension
public java.lang.String getExtension()
Getter for the field
extension
.- Overrides:
getExtension
in classorg.apache.maven.doxia.sink.render.RenderingContext
- Returns:
- a
String
object.
-
-