public class ReadmeHtmlVelocityDelegate extends Object
README.html
that moves along with the
release for the sake of downloading the release from the distribution area.Modifier and Type | Class and Description |
---|---|
static class |
ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
A builder class for instantiation of the
ReadmeHtmlVelocityDelegate . |
Modifier and Type | Field and Description |
---|---|
private String |
artifactId
This is supposed to represent the maven artifactId.
|
private String |
siteUrl
The url of the site that gets set into the
README.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.
|
Modifier | Constructor and Description |
---|---|
private |
ReadmeHtmlVelocityDelegate(String artifactId,
String version,
String siteUrl)
The private constructor to be used by the
ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder . |
Modifier and Type | Method and 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 . |
private static final String TEMPLATE
private final String artifactId
private final String version
private final String siteUrl
README.html
.private ReadmeHtmlVelocityDelegate(String artifactId, String version, String siteUrl)
ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
.artifactId
- sets the artifactId
.version
- sets the version
.siteUrl
- sets the siteUrl
.public static ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder builder()
ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
for constructing the ReadmeHtmlVelocityDelegate
.public Writer render(Writer writer)
README.vm
velocity template with the variables constructed with the
ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
.Copyright © 2018–2022 The Apache Software Foundation. All rights reserved.