org.apache.maven.doxia.sink.render
Class RenderingContext

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

public class RenderingContext
extends 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

RenderingContext(File basedir, String document)
Constructor for RenderingContext.

RenderingContext(File basedir, String document, String parserId)
Constructor for RenderingContext.

RenderingContext(File basedir, String document, String parserId, String extension)
Constructor for RenderingContext.

Method Summary

String	getAttribute(String key) getAttribute.
File	getBasedir() Getter for the field basedir.
String	getExtension() Getter for the field extension.
String	getInputName() Getter for the field inputName.
String	getOutputName() Getter for the field outputName.
String	getParserId() Getter for the field parserId.
String	getRelativePath() Getter for the field relativePath.
void	setAttribute(String key, 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(File basedir,
                        String document)

Constructor for RenderingContext.

Parameters:

basedir - a File object.

document - a String object.

RenderingContext

public RenderingContext(File basedir,
                        String document,
                        String parserId)

Constructor for RenderingContext.

Parameters:

basedir - a File object.

document - a String object.

parserId - a String object.

RenderingContext

public RenderingContext(File basedir,
                        String document,
                        String parserId,
                        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 File getBasedir()

Getter for the field basedir.

Returns:

a File object.

getInputName

public String getInputName()

Getter for the field inputName.

Returns:

a String object.

getOutputName

public String getOutputName()

Getter for the field outputName.

Returns:

a String object.

getParserId

public String getParserId()

Getter for the field parserId.

Returns:

a String object.

getRelativePath

public String getRelativePath()

Getter for the field relativePath.

Returns:

a String object.

setAttribute

public void setAttribute(String key,
                         String value)

setAttribute.

Parameters:

key - a String object.

value - a String object.

getAttribute

public String getAttribute(String key)

getAttribute.

Parameters:

key - a String object.

Returns:

a String object.

getExtension

public String getExtension()

Getter for the field extension.

Returns:

a String object.