Class ReadmeHtmlVelocityDelegate
- java.lang.Object
-
- org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
-
public class ReadmeHtmlVelocityDelegate extends Object
This class' purpose is to generate theREADME.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 theReadmeHtmlVelocityDelegate
.
-
Field Summary
Fields Modifier and Type Field Description private String
artifactId
This is supposed to represent the maven artifactId.private String
siteUrl
The url of the site that gets set into theREADME.html
.private static String
TEMPLATE
The location of the velocity template for this class.private String
version
This is supposed to represent the maven version of the release.
-
Constructor Summary
Constructors Modifier Constructor Description private
ReadmeHtmlVelocityDelegate(String artifactId, String version, String siteUrl)
The private constructor to be used by theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
builder()
Gets theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
for constructing theReadmeHtmlVelocityDelegate
.Writer
render(Writer writer)
Renders theREADME.vm
velocity template with the variables constructed with theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
.
-
-
-
Field Detail
-
TEMPLATE
private static final String TEMPLATE
The location of the velocity template for this class.- See Also:
- Constant Field Values
-
artifactId
private final String artifactId
This is supposed to represent the maven artifactId.
-
version
private final String version
This is supposed to represent the maven version of the release.
-
-
Constructor Detail
-
ReadmeHtmlVelocityDelegate
private ReadmeHtmlVelocityDelegate(String artifactId, String version, String siteUrl)
The private constructor to be used by theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
.- Parameters:
artifactId
- sets theartifactId
.version
- sets theversion
.siteUrl
- sets thesiteUrl
.
-
-
Method Detail
-
builder
public static ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder builder()
Gets theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
for constructing theReadmeHtmlVelocityDelegate
.
-
render
public Writer render(Writer writer)
Renders theREADME.vm
velocity template with the variables constructed with theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
.
-
-