Class ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
java.lang.Object
org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
- Enclosing class:
- ReadmeHtmlVelocityDelegate
A builder class for instantiation of the
ReadmeHtmlVelocityDelegate.-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivatePrivate constructor for using the builder through theReadmeHtmlVelocityDelegate.builder()method. -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds up theReadmeHtmlVelocityDelegatefrom the previously set parameters.withArtifactId(String artifactId) Adds the artifactId to theReadmeHtmlVelocityDelegate.withSiteUrl(String siteUrl) Adds the siteUrl to theReadmeHtmlVelocityDelegate.withVersion(String version) Adds the version to theReadmeHtmlVelocityDelegate.
-
Field Details
-
artifactId
The maven artifactId to use in theREADME.vmtemplate. -
version
The maven version to use in theREADME.vmtemplate. -
siteUrl
The site url to use in theREADME.vmtemplate.
-
-
Constructor Details
-
ReadmeHtmlVelocityDelegateBuilder
private ReadmeHtmlVelocityDelegateBuilder()Private constructor for using the builder through theReadmeHtmlVelocityDelegate.builder()method.
-
-
Method Details
-
withArtifactId
public ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder withArtifactId(String artifactId) Adds the artifactId to theReadmeHtmlVelocityDelegate.- Parameters:
artifactId- theStringrepresenting the maven artifactId.- Returns:
- the builder to continue building.
-
withVersion
Adds the version to theReadmeHtmlVelocityDelegate.- Parameters:
version- the maven version.- Returns:
- the builder to continue building.
-
withSiteUrl
Adds the siteUrl to theReadmeHtmlVelocityDelegate.- Parameters:
siteUrl- the site url to be used in theREADME.html- Returns:
- the builder to continue building.
-
build
Builds up theReadmeHtmlVelocityDelegatefrom the previously set parameters.- Returns:
- a new
ReadmeHtmlVelocityDelegate.
-