Package org.codehaus.plexus.velocity

Class DefaultVelocityComponent

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.plexus.velocity.DefaultVelocityComponent

All Implemented Interfaces:

org.codehaus.plexus.logging.LogEnabled, org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable, VelocityComponent

public class DefaultVelocityComponent
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements VelocityComponent, org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable

A simple velocity component implementation.

A typical configuration will look like this:

      <configuration>
        <properties>
          <property>
            <name>resource.loader</name>
            <value>classpath</value>
          </property>
          <property>
            <name>classpath.resource.loader.class</name>
            <value>org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader</value>
          </property>
        </properties>
      </configuration>
 

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.velocity.app.VelocityEngine	engine
private Properties	properties

Fields inherited from interface org.codehaus.plexus.velocity.VelocityComponent

ROLE

Constructor Summary

Constructors

Constructor	Description
DefaultVelocityComponent()

Method Summary

Modifier and Type	Method	Description
org.apache.velocity.app.VelocityEngine	getEngine()
void	initialize()

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

engine

private org.apache.velocity.app.VelocityEngine engine

properties

private Properties properties

Constructor Details

DefaultVelocityComponent

public DefaultVelocityComponent()

Method Details

initialize

public void initialize()
                throws org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException

Specified by:

initialize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable

Throws:

org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException

getEngine

public org.apache.velocity.app.VelocityEngine getEngine()

Specified by:

getEngine in interface VelocityComponent