org.codehaus.mojo.webstart.generator

Class AbstractGenerator<C extends GeneratorExtraConfig>

java.lang.Object

org.codehaus.mojo.webstart.generator.AbstractGenerator<C>

Direct Known Subclasses:

ExtensionGenerator, Generator, JarResourcesGenerator

public abstract class AbstractGenerator<C extends GeneratorExtraConfig>
extends Object

The abstract superclass for classes that generate the JNLP files produced by the various MOJOs available in the plugin.

Since:

30 Aug 2007

Version:

$Revision$

Author:

Kevin Stembridge

Field Summary

Fields

Modifier and Type	Field and Description
static String	EOL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGenerator(org.apache.maven.plugin.logging.Log log, GeneratorTechnicalConfig config, C extraConfig)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.velocity.VelocityContext	createAndPopulateContext() Creates a Velocity context and populates it with replacement values for our pre-defined placeholders.
void	generate() Generate the JNLP file.
protected abstract String	getArgumentsText()
protected abstract String	getDependenciesText() Subclasses must implement this method to return the text that should replace the $dependencies placeholder in the JNLP template.
C	getExtraConfig()
protected String	indentText(int level, String text) Add level space caracteres at the begin of each lines of the given text.

Methods inherited from class java.lang.Object

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

Field Detail

EOL

public static final String EOL

Constructor Detail

AbstractGenerator

protected AbstractGenerator(org.apache.maven.plugin.logging.Log log,
                 GeneratorTechnicalConfig config,
                 C extraConfig)

Method Detail

getExtraConfig

public C getExtraConfig()

generate

public final void generate()
                    throws Exception

Generate the JNLP file.

Throws:

Exception

getDependenciesText

protected abstract String getDependenciesText()

Subclasses must implement this method to return the text that should replace the $dependencies placeholder in the JNLP template.

Returns:

The dependencies text, never null.

createAndPopulateContext

protected org.apache.velocity.VelocityContext createAndPopulateContext()

Creates a Velocity context and populates it with replacement values for our pre-defined placeholders.

Returns:

Returns a velocity context with system and maven properties added

getArgumentsText

protected abstract String getArgumentsText()

indentText

protected String indentText(int level,
                String text)

Add level space caracteres at the begin of each lines of the given text.

Parameters:

level - the number of space caracteres to add

text - the text to prefix

Returns:

the indented text