org.nuiton.jredmine.plugin.announcement

Class AnnouncementGenerator

java.lang.Object

org.nuiton.jredmine.plugin.announcement.AnnouncementGenerator

public class AnnouncementGenerator
extends Object

Since:

1.0.0

Author:

tchemit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AnnouncementGenerator.ArtifactComparator

Constructor Summary

Constructors

Constructor and Description
AnnouncementGenerator(AnnouncementGeneratorConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateAttachmentLinks() Checks whether links to the issues can be generated.
org.apache.velocity.context.Context	createVelocityContext(List<?> releases)
void	doGenerate(org.apache.velocity.app.VelocityEngine engine, org.apache.velocity.context.Context context, File out, String templatePath, String templateEncoding)
Map<File,String>	getArtifactsUrls(String url, String versionId, boolean verbose, File[] files)
String	getAttachmentLinkTemplate()
Map<Attachment,String>	getAttachmentsUrls(Attachment[] attachments)
org.apache.maven.plugins.changes.model.Release	getLatestRelease(List<?> releases, String releaseVersion) Get the latest release by matching the supplied releases with the version from the pom.
org.apache.maven.plugin.logging.Log	getLog()
protected org.apache.maven.plugins.changes.model.Release	getRelease(List<?> releases, String version)
String	getUrl()
protected String	parseAttachmentLink(String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnouncementGenerator

public AnnouncementGenerator(AnnouncementGeneratorConfiguration configuration)

Method Detail

getAttachmentLinkTemplate

public String getAttachmentLinkTemplate()

getLog

public org.apache.maven.plugin.logging.Log getLog()

getUrl

public String getUrl()

getAttachmentsUrls

public Map<Attachment,String> getAttachmentsUrls(Attachment[] attachments)

getArtifactsUrls

public Map<File,String> getArtifactsUrls(String url,
                                String versionId,
                                boolean verbose,
                                File[] files)

createVelocityContext

public org.apache.velocity.context.Context createVelocityContext(List<?> releases)
                                                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

doGenerate

public void doGenerate(org.apache.velocity.app.VelocityEngine engine,
              org.apache.velocity.context.Context context,
              File out,
              String templatePath,
              String templateEncoding)
                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

canGenerateAttachmentLinks

public boolean canGenerateAttachmentLinks()

Checks whether links to the issues can be generated.

Returns:

true if issue links can be generated, false otherwise.

parseAttachmentLink

protected String parseAttachmentLink(String id)

getLatestRelease

public org.apache.maven.plugins.changes.model.Release getLatestRelease(List<?> releases,
                                                              String releaseVersion)
                                                                throws org.apache.maven.plugin.MojoExecutionException

Get the latest release by matching the supplied releases with the version from the pom.

Parameters:

releases - list of releases

releaseVersion - the release version

Returns:

A Release that matches the next release of the current project

Throws:

org.apache.maven.plugin.MojoExecutionException - if any pb

getRelease

protected org.apache.maven.plugins.changes.model.Release getRelease(List<?> releases,
                                                        String version)