Class HeaderHtmlVelocityDelegate

java.lang.Object

org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate

public final class HeaderHtmlVelocityDelegate
extends Object

Generates the HEADER.html file that accompanies the release in the distribution area.

Since:

1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder	A builder class for instantiation of the HeaderHtmlVelocityDelegate.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	TEMPLATE	The location of the Velocity template for this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	HeaderHtmlVelocityDelegate()	The private constructor to be used by the HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.

Method Summary

Modifier and Type	Method	Description
static HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder	builder()	Gets a builder for constructing a HeaderHtmlVelocityDelegate.
Writer	render(Writer writer)	Renders the HEADER.vm Velocity template to the supplied writer.

Methods inherited from class Object

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

Field Details

TEMPLATE

private static final String TEMPLATE

The location of the Velocity template for this class.

See Also:

• Constant Field Values

Constructor Details

HeaderHtmlVelocityDelegate

private HeaderHtmlVelocityDelegate()

The private constructor to be used by the HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.

Method Details

builder

public static HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder builder()

Gets a builder for constructing a HeaderHtmlVelocityDelegate.

Returns:

A HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.

render

public Writer render(Writer writer)

Renders the HEADER.vm Velocity template to the supplied writer.

Parameters:

writer - any Writer that we wish to have the filled Velocity template written to.

Returns:

The Writer to which the template was rendered.