org.nuiton.jredmine.plugin.announcement
Class AnnouncementGenerator

java.lang.Object
  org.nuiton.jredmine.plugin.announcement.AnnouncementGenerator

public class AnnouncementGenerator
extends java.lang.Object

Since:

1.0.0

Author:

chemit

Field Summary

protected java.lang.String	attachmentLinkTemplate the redmine attachment url template
protected java.lang.String	url the redmine url

Constructor Summary

AnnouncementGenerator(org.apache.maven.plugin.logging.Log log, java.lang.String url, java.lang.String attachmentLinkTemplate)

Method Summary

boolean	canGenerateAttachmentLinks() Checks whether links to the issues can be generated.
void	doGenerate(org.apache.velocity.app.VelocityEngine engine, org.apache.velocity.context.Context context, java.io.File out, java.lang.String templatePath, java.lang.String templateEncoding)
java.util.Map<Attachment,java.lang.String>	getAttachmentsUrls(Attachment[] attachments)
org.apache.maven.plugins.changes.model.Release	getLatestRelease(java.util.List<?> releases, java.lang.String releaseVersion) Get the latest release by matching the supplied releases with the version from the pom.
protected org.apache.maven.plugin.logging.Log	getLog()
protected org.apache.maven.plugins.changes.model.Release	getRelease(java.util.List<?> releases, java.lang.String version)
protected java.lang.String	parseAttachmentLink(java.lang.String id)

Methods inherited from class java.lang.Object

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

Field Detail

url

protected final java.lang.String url

the redmine url

attachmentLinkTemplate

protected final java.lang.String attachmentLinkTemplate

the redmine attachment url template

Constructor Detail

AnnouncementGenerator

public AnnouncementGenerator(org.apache.maven.plugin.logging.Log log,
                             java.lang.String url,
                             java.lang.String attachmentLinkTemplate)

Method Detail

getAttachmentsUrls

public java.util.Map<Attachment,java.lang.String> getAttachmentsUrls(Attachment[] attachments)

doGenerate

public void doGenerate(org.apache.velocity.app.VelocityEngine engine,
                       org.apache.velocity.context.Context context,
                       java.io.File out,
                       java.lang.String templatePath,
                       java.lang.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 java.lang.String parseAttachmentLink(java.lang.String id)

getLatestRelease

public org.apache.maven.plugins.changes.model.Release getLatestRelease(java.util.List<?> releases,
                                                                       java.lang.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

getRelease

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

getLog

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