Class ReadmeHtmlVelocityDelegate
java.lang.Object
org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
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 ClassesModifier and TypeClassDescriptionstatic classA builder class for instantiation of theReadmeHtmlVelocityDelegate. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final StringThis is supposed to represent the maven artifactId.private final StringThe url of the site that gets set into theREADME.html.private static final StringThe location of the velocity template for this class.private final StringThis is supposed to represent the maven version of the release. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateReadmeHtmlVelocityDelegate(String artifactId, String version, String siteUrl) The private constructor to be used by theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder. -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Gets theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilderfor constructing theReadmeHtmlVelocityDelegate.Renders theREADME.vmvelocity template with the variables constructed with theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.
-
Field Details
-
TEMPLATE
The location of the velocity template for this class.- See Also:
-
artifactId
This is supposed to represent the maven artifactId. -
version
This is supposed to represent the maven version of the release. -
siteUrl
The url of the site that gets set into theREADME.html.
-
-
Constructor Details
-
ReadmeHtmlVelocityDelegate
The private constructor to be used by theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.- Parameters:
artifactId- sets theartifactId.version- sets theversion.siteUrl- sets thesiteUrl.
-
-
Method Details
-
builder
Gets theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilderfor constructing theReadmeHtmlVelocityDelegate. -
render
Renders theREADME.vmvelocity template with the variables constructed with theReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.
-