A B C D E G I L O P R S V

A

AbstractDoxiaResourceLoader - Class in org.apache.velocity.site.doxia.velocity

This is the base for Doxia-related Velocity ResourceLoader.

AbstractDoxiaResourceLoader() - Constructor for class org.apache.velocity.site.doxia.velocity.AbstractDoxiaResourceLoader

Creates a new AbstractDoxiaResourceLoader object.

AbstractVelocityRenderer - Class in org.apache.velocity.site.doxia.renderer

This is the base class for the various parsers.

AbstractVelocityRenderer(String) - Constructor for class org.apache.velocity.site.doxia.renderer.AbstractVelocityRenderer

Creates a new AbstractVelocityRenderer object.

addContextElement(String, Object) - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaVelocityContextFactory

addContextElement(String, Object) - Method in interface org.apache.velocity.site.doxia.velocity.DoxiaVelocityContextFactory

Add a new Element to be used in the Velocity context.

B

bindRealm(PlexusContainer, PlexusContainer, String) - Static method in class org.apache.velocity.site.plexus.PlexusKludgeUtils

C

container - Variable in class org.apache.velocity.site.doxia.renderer.AbstractVelocityRenderer

CONTAINER_LOOKUP_NAME - Static variable in class org.apache.velocity.site.doxia.plugin.DoxiaVelocityRendererPlugin

Lookup Key for Plexus Container

contextualize(Context) - Method in class org.apache.velocity.site.doxia.renderer.AbstractVelocityRenderer

D

DefaultDoxiaLibraryLoader - Class in org.apache.velocity.site.doxia.velocity

This ResourceLoader is responsible for loading the configured macro libraries.

DefaultDoxiaLibraryLoader() - Constructor for class org.apache.velocity.site.doxia.velocity.DefaultDoxiaLibraryLoader

Creates a new DefaultDoxiaLibraryLoader object.

DefaultDoxiaResourceLoader - Class in org.apache.velocity.site.doxia.velocity

This loader reads the current template from a passed in Reader object and returns the template as an InputStream for Velocity to use.

DefaultDoxiaResourceLoader() - Constructor for class org.apache.velocity.site.doxia.velocity.DefaultDoxiaResourceLoader

DefaultDoxiaVelocityContextFactory - Class in org.apache.velocity.site.doxia.velocity

This factory returns configured VelocityContext objects for the renderers.

DefaultDoxiaVelocityContextFactory() - Constructor for class org.apache.velocity.site.doxia.velocity.DefaultDoxiaVelocityContextFactory

DefaultVelocityRunner - Class in org.apache.velocity.site.doxia.runner

DefaultVelocityRunner() - Constructor for class org.apache.velocity.site.doxia.runner.DefaultVelocityRunner

DoxiaLibraryLoader - Interface in org.apache.velocity.site.doxia.velocity

This is the Role definition for the Doxia Library Loader component.

DoxiaResourceLoader - Interface in org.apache.velocity.site.doxia.velocity

This loader reads the current template from a passed in Reader object and returns the template as an InputStream for Velocity to use.

DoxiaVelocityContextFactory - Interface in org.apache.velocity.site.doxia.velocity

This is the Role definition for the Doxia Velocity Context Factory component.

DoxiaVelocityRendererPlugin - Class in org.apache.velocity.site.doxia.plugin

This plugin initialized and configures the Velocity engine used to pre-render templates for the Doxia site.

DoxiaVelocityRendererPlugin() - Constructor for class org.apache.velocity.site.doxia.plugin.DoxiaVelocityRendererPlugin

E

enableLogging(Logger) - Method in class org.apache.velocity.site.doxia.runner.DefaultVelocityRunner

enableLogging(Logger) - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaLibraryLoader

enableLogging(Logger) - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaResourceLoader

enableLogging(Logger) - Method in class org.apache.velocity.site.doxia.velocity.PlexusLogger

execute() - Method in class org.apache.velocity.site.doxia.plugin.DoxiaVelocityRendererPlugin

Plugin Execution.

G

getExtension() - Method in class org.apache.velocity.site.doxia.renderer.VelocityAptSiteModule

Returns the File extension.

getExtension() - Method in class org.apache.velocity.site.doxia.renderer.VelocityXdocSiteModule

Returns the File extension.

getInstance() - Method in class org.apache.velocity.site.doxia.util.VelocityTool

Returns the instance object for this tool.

getKnownLibraries() - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaLibraryLoader

Returns the list of known macro libraries.

getKnownLibraries() - Method in interface org.apache.velocity.site.doxia.velocity.DoxiaLibraryLoader

Returns the list of known macro libraries.

getLastModified(Resource) - Method in class org.apache.velocity.site.doxia.velocity.AbstractDoxiaResourceLoader

getParser() - Method in class org.apache.velocity.site.doxia.renderer.AbstractVelocityRenderer

Returns the actual Parser (currently only Apt and Xdoc) must be injected into an instance of this component.

getParserId() - Method in class org.apache.velocity.site.doxia.renderer.VelocityAptSiteModule

Returns the parser id for the files to render.

getParserId() - Method in class org.apache.velocity.site.doxia.renderer.VelocityXdocSiteModule

Returns the parser id for the files to render.

getResourceStream(String) - Method in class org.apache.velocity.site.doxia.velocity.AbstractDoxiaResourceLoader

getResourceStream(String) - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaLibraryLoader

Returns an input stream for the given template name.

getResourceStream(String) - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaResourceLoader

Returns the template available from the Reader that has been set using DefaultDoxiaResourceLoader.setTemplateReader(Reader) when the requested template name is the empty string.

getSourceDirectory() - Method in class org.apache.velocity.site.doxia.renderer.VelocityAptSiteModule

Returns the Source Directory.

getSourceDirectory() - Method in class org.apache.velocity.site.doxia.renderer.VelocityXdocSiteModule

Returns the Source Directory.

getToolClass() - Method in class org.apache.velocity.site.doxia.util.VelocityTool

Returns the tool class.

getToolName() - Method in class org.apache.velocity.site.doxia.util.VelocityTool

Returns the tool name.

getVelocityContext() - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaVelocityContextFactory

getVelocityContext() - Method in interface org.apache.velocity.site.doxia.velocity.DoxiaVelocityContextFactory

Returns a configured VelocityContext object to use.

I

init(ExtendedProperties) - Method in class org.apache.velocity.site.doxia.velocity.AbstractDoxiaResourceLoader

init(RuntimeServices) - Method in class org.apache.velocity.site.doxia.velocity.PlexusLogger

initVelocity() - Method in class org.apache.velocity.site.doxia.runner.DefaultVelocityRunner

initVelocity() - Method in interface org.apache.velocity.site.doxia.runner.VelocityRunner

isCachingOn() - Method in class org.apache.velocity.site.doxia.velocity.AbstractDoxiaResourceLoader

isLevelEnabled(int) - Method in class org.apache.velocity.site.doxia.velocity.PlexusLogger

isSourceModified(Resource) - Method in class org.apache.velocity.site.doxia.velocity.AbstractDoxiaResourceLoader

L

log(int, String) - Method in class org.apache.velocity.site.doxia.velocity.PlexusLogger

log(int, String, Throwable) - Method in class org.apache.velocity.site.doxia.velocity.PlexusLogger

lookupContainer(PlexusContainer, String) - Static method in class org.apache.velocity.site.plexus.PlexusKludgeUtils

O

org.apache.velocity.site.doxia.plugin - package org.apache.velocity.site.doxia.plugin

org.apache.velocity.site.doxia.renderer - package org.apache.velocity.site.doxia.renderer

org.apache.velocity.site.doxia.runner - package org.apache.velocity.site.doxia.runner

org.apache.velocity.site.doxia.util - package org.apache.velocity.site.doxia.util

org.apache.velocity.site.doxia.velocity - package org.apache.velocity.site.doxia.velocity

org.apache.velocity.site.plexus - package org.apache.velocity.site.plexus

P

parse(Reader, Sink) - Method in class org.apache.velocity.site.doxia.renderer.AbstractVelocityRenderer

This is the actual parsing stage.

PARSE_METHOD - Static variable in interface org.apache.velocity.site.doxia.runner.VelocityRunner

PARSE_METHOD_SIGNATURE - Static variable in interface org.apache.velocity.site.doxia.runner.VelocityRunner

parseVelocity(Reader) - Method in class org.apache.velocity.site.doxia.runner.DefaultVelocityRunner

This is the actual parsing stage.

parseVelocity(Reader) - Method in interface org.apache.velocity.site.doxia.runner.VelocityRunner

PlexusKludgeException - Exception in org.apache.velocity.site.plexus

Generic Exception for the news extension.

PlexusKludgeException(String) - Constructor for exception org.apache.velocity.site.plexus.PlexusKludgeException

PlexusKludgeException(Throwable) - Constructor for exception org.apache.velocity.site.plexus.PlexusKludgeException

PlexusKludgeException(String, Throwable) - Constructor for exception org.apache.velocity.site.plexus.PlexusKludgeException

PlexusKludgeUtils - Class in org.apache.velocity.site.plexus

PlexusLogger - Class in org.apache.velocity.site.doxia.velocity

An implementation of a LogChute to use with Velocity that logs into Plexus logging.

PlexusLogger() - Constructor for class org.apache.velocity.site.doxia.velocity.PlexusLogger

Creates a new PlexusLogger object.

R

ROLE - Static variable in interface org.apache.velocity.site.doxia.runner.VelocityRunner

Plexus Role Definition

ROLE - Static variable in interface org.apache.velocity.site.doxia.velocity.DoxiaLibraryLoader

Plexus Role Definition

ROLE - Static variable in interface org.apache.velocity.site.doxia.velocity.DoxiaResourceLoader

Plexus Role Definition

ROLE - Static variable in interface org.apache.velocity.site.doxia.velocity.DoxiaVelocityContextFactory

Plexus Role Definition

ROLE - Static variable in class org.apache.velocity.site.doxia.velocity.PlexusLogger

S

setCachingOn(boolean) - Method in class org.apache.velocity.site.doxia.velocity.AbstractDoxiaResourceLoader

setKnownLibraries(String[]) - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaLibraryLoader

Sets the list of known library.

setKnownLibraries(String[]) - Method in interface org.apache.velocity.site.doxia.velocity.DoxiaLibraryLoader

Sets the list of known library.

setSiteDirectory(File) - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaLibraryLoader

Set the base directory for the maven site generation.

setSiteDirectory(File) - Method in interface org.apache.velocity.site.doxia.velocity.DoxiaLibraryLoader

Set the base directory for the maven site generation.

setTemplateReader(Reader) - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaResourceLoader

Set the Reader object for the loader to use.

setTemplateReader(Reader) - Method in interface org.apache.velocity.site.doxia.velocity.DoxiaResourceLoader

Set the Reader object for the loader to use.

setToolClass(String) - Method in class org.apache.velocity.site.doxia.util.VelocityTool

Sets the tool class.

setToolName(String) - Method in class org.apache.velocity.site.doxia.util.VelocityTool

Sets the tool name to use.

setTools(VelocityTool[]) - Method in class org.apache.velocity.site.doxia.velocity.DefaultDoxiaVelocityContextFactory

setTools(VelocityTool[]) - Method in interface org.apache.velocity.site.doxia.velocity.DoxiaVelocityContextFactory

Set a list of VelocityTool objects to use in the Velocity context.

V

VelocityAptRenderer - Class in org.apache.velocity.site.doxia.renderer

This is the apt-parsing instance of the AbstractVelocityRenderer.

VelocityAptRenderer() - Constructor for class org.apache.velocity.site.doxia.renderer.VelocityAptRenderer

Creates a new VelocityAptRenderer object.

VelocityAptSiteModule - Class in org.apache.velocity.site.doxia.renderer

This module connects the renderer with the Doxia core.

VelocityAptSiteModule() - Constructor for class org.apache.velocity.site.doxia.renderer.VelocityAptSiteModule

VelocityDoxiaRendererException - Exception in org.apache.velocity.site.doxia.util

Generic Exception for the news extension.

VelocityDoxiaRendererException(String) - Constructor for exception org.apache.velocity.site.doxia.util.VelocityDoxiaRendererException

VelocityDoxiaRendererException(Throwable) - Constructor for exception org.apache.velocity.site.doxia.util.VelocityDoxiaRendererException

VelocityDoxiaRendererException(String, Throwable) - Constructor for exception org.apache.velocity.site.doxia.util.VelocityDoxiaRendererException

VelocityRunner - Interface in org.apache.velocity.site.doxia.runner

VelocityTool - Class in org.apache.velocity.site.doxia.util

This is a wrapper object for a Class to be used as a Velocity Tool.

VelocityTool() - Constructor for class org.apache.velocity.site.doxia.util.VelocityTool

VelocityXdocRenderer - Class in org.apache.velocity.site.doxia.renderer

This is the xdoc-parsing instance of the AbstractVelocityRenderer.

VelocityXdocRenderer() - Constructor for class org.apache.velocity.site.doxia.renderer.VelocityXdocRenderer

Creates a new VelocityXdocRenderer object.

VelocityXdocSiteModule - Class in org.apache.velocity.site.doxia.renderer

This module connects the renderer with the Doxia core.

VelocityXdocSiteModule() - Constructor for class org.apache.velocity.site.doxia.renderer.VelocityXdocSiteModule

A B C D E G I L O P R S V