net.sourceforge.cruisecontrol.config
Class PluginPlugin

java.lang.Object
  net.sourceforge.cruisecontrol.config.PluginPlugin

All Implemented Interfaces:

SelfConfiguringPlugin

public class PluginPlugin

extends java.lang.Object

implements SelfConfiguringPlugin

A <plugin> element registers a classname with an alias for use within the configuration file.

Plugins can also be pre-configured at registration time. This can greatly reduce the configuration file size.

The plugins page contains a discussion of the plugin architecture used with CruiseControl.

Constructor Summary

PluginPlugin()

Method Summary

void	configure(org.jdom.Element element)
java.lang.String	getClassname()
java.lang.String	getName()
org.jdom.Element	getTransformedElement()
void	setClassname(java.lang.String className) The class that implements the plugin.
void	setName(java.lang.String name) The alias used to refer to the plugin elsewhere in the configuration file.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginPlugin

public PluginPlugin()

Method Detail

setName

public void setName(java.lang.String name)

The alias used to refer to the plugin elsewhere in the configuration file.

Parameters:

name - the plugin name

setClassname

public void setClassname(java.lang.String className)

The class that implements the plugin.

Parameters:

className - the plugin class name

getName

public java.lang.String getName()

getClassname

public java.lang.String getClassname()

configure

public void configure(org.jdom.Element element)
               throws CruiseControlException

Specified by:

configure in interface SelfConfiguringPlugin

Parameters:

element -

Throws:

CruiseControlException

getTransformedElement

public org.jdom.Element getTransformedElement()