Package org.apache.commons.release.plugin.velocity

Class ReadmeHtmlVelocityDelegate

java.lang.Object

org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate

public class ReadmeHtmlVelocityDelegate
extends Object

This class' purpose is to generate the README.html that moves along with the release for the sake of downloading the release from the distribution area.

Since:

1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder	A builder class for instantiation of the ReadmeHtmlVelocityDelegate.

Method Summary

Modifier and Type	Method	Description
static ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder	builder()	Gets the ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder for constructing the ReadmeHtmlVelocityDelegate.
Writer	render(Writer writer)	Renders the README.vm velocity template with the variables constructed with the ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder builder()

Gets the ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder for constructing the ReadmeHtmlVelocityDelegate.

Returns:

the ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.

render

public Writer render(Writer writer)

Renders the README.vm velocity template with the variables constructed with the ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.

Parameters:

writer - is the Writer to which we wish to render the README.vm template.

Returns:

a reference to the Writer passed in.