Package org.apache.maven.plugins.changes.announcement

Class AnnouncementMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.changes.AbstractChangesMojo
org.apache.maven.plugins.changes.announcement.AbstractAnnouncementMojo
org.apache.maven.plugins.changes.announcement.AnnouncementMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
@Mojo(name="announcement-generate", threadSafe=true) public class AnnouncementMojo extends AbstractAnnouncementMojo
Goal which generates an announcement from the announcement template.
Since:
2.0-beta-2
Version:
$Id$
Author:
aramirez@exist.com

  • Constructor Details

    • AnnouncementMojo

      @Inject public AnnouncementMojo(org.codehaus.plexus.velocity.VelocityComponent velocity, org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

  • Method Details

    • execute

      public void execute() throws org.apache.maven.plugin.MojoExecutionException
      Generate the template
      Throws:
      org.apache.maven.plugin.MojoExecutionException - in case of errors

    • doGenerate

      public void doGenerate(List<Release> releases) throws org.apache.maven.plugin.MojoExecutionException
      Add the parameters to velocity context
      Parameters:
      releases - A List of Releases
      Throws:
      org.apache.maven.plugin.MojoExecutionException - in case of errors

    • doGenerate

      protected void doGenerate(List<Release> releases, Release release) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • processTemplate

      public void processTemplate(org.apache.velocity.context.Context context, File outputDirectory, String template, String announcementFile) throws org.apache.velocity.exception.VelocityException, org.apache.maven.plugin.MojoExecutionException
      Create the Velocity template.
      Parameters:
      context - velocity context that has the parameter values
      outputDirectory - directory where the file will be generated
      template - velocity template which will the context be merged
      announcementFile - the file name of the generated announcement
      Throws:
      org.apache.velocity.exception.VelocityException - in case of error processing the Velocity template
      org.apache.maven.plugin.MojoExecutionException - in case of errors

    • getJiraReleases

      protected List<Release> getJiraReleases() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • getTracReleases

      protected List<Release> getTracReleases() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • getGitHubReleases

      protected List<Release> getGitHubReleases() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • getArtifactId

      public String getArtifactId()

    • setArtifactId

      public void setArtifactId(String artifactId)

    • getDevelopmentTeam

      public String getDevelopmentTeam()

    • setDevelopmentTeam

      public void setDevelopmentTeam(String developmentTeam)

    • getFinalName

      public String getFinalName()

    • setFinalName

      public void setFinalName(String finalName)

    • getGroupId

      public String getGroupId()

    • setGroupId

      public void setGroupId(String groupId)

    • getIntroduction

      public String getIntroduction()

    • setIntroduction

      public void setIntroduction(String introduction)

    • setIssueTypes

      public void setIssueTypes(Map<String,String> issueTypes)

    • getIssueTypes

      public Map<String,String> getIssueTypes()

    • getAnnouncementDirectory

      public File getAnnouncementDirectory()

    • setAnnouncementDirectory

      public void setAnnouncementDirectory(File announcementDirectory)

    • getPackaging

      public String getPackaging()

    • setPackaging

      public void setPackaging(String packaging)

    • getUrl

      public String getUrl()

    • setUrl

      public void setUrl(String url)

    • getUrlDownload

      public String getUrlDownload()

    • setUrlDownload

      public void setUrlDownload(String urlDownload)

    • getVersion

      public String getVersion()

    • setVersion

      public void setVersion(String version)

    • getXml

      public ChangesXML getXml()

    • setXml

      public void setXml(ChangesXML xml)

    • getXmlPath

      public File getXmlPath()

    • setXmlPath

      public void setXmlPath(File xmlPath)