org.apache.maven.plugins.changes.model.Release Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-changes-plugin Show documentation
Creates a release history for inclusion into the site and assists in generating an announcement mail.
There is a newer version: 2.12.1
/*
 =================== DO NOT EDIT THIS FILE ====================
 Generated by Modello 1.0.1 on 2012-05-10 17:26:02,
 any modifications will be overwritten.
 ==============================================================
 */

package org.apache.maven.plugins.changes.model;

/**
 * A single release of this project.
 * 
 * @version $Revision$ $Date$
 */
public class Release
    implements java.io.Serializable
{

      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * 
     *             The version number associated with this release.
     *           
     */
    private String version;

    /**
     * 
     *             
     *             The date of this release.
     *             This field can be any String, such as "in
     * SVN" when the version isn't yet released. 
     *           
     *           
     */
    private String dateRelease;

    /**
     * 
     *             A short description of this release.
     *           
     */
    private String description;

    /**
     * Field actions.
     */
    private java.util.List actions;


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * Method addAction.
     * 
     * @param action
     */
    public void addAction( Action action )
    {
        if ( !(action instanceof Action) )
        {
            throw new ClassCastException( "Release.addActions(action) parameter must be instanceof " + Action.class.getName() );
        }
        getActions().add( action );
    } //-- void addAction( Action )

    /**
     * Method getActions.
     * 
     * @return List
     */
    public java.util.List getActions()
    {
        if ( this.actions == null )
        {
            this.actions = new java.util.ArrayList();
        }

        return this.actions;
    } //-- java.util.List getActions()

    /**
     * Get The date of this release.
     *             This field can be any String, such as "in
     * SVN" when the version isn't yet released. 
     * 
     * @return String
     */
    public String getDateRelease()
    {
        return this.dateRelease;
    } //-- String getDateRelease()

    /**
     * Get a short description of this release.
     * 
     * @return String
     */
    public String getDescription()
    {
        return this.description;
    } //-- String getDescription()

    /**
     * Get the version number associated with this release.
     * 
     * @return String
     */
    public String getVersion()
    {
        return this.version;
    } //-- String getVersion()

    /**
     * Method removeAction.
     * 
     * @param action
     */
    public void removeAction( Action action )
    {
        if ( !(action instanceof Action) )
        {
            throw new ClassCastException( "Release.removeActions(action) parameter must be instanceof " + Action.class.getName() );
        }
        getActions().remove( action );
    } //-- void removeAction( Action )

    /**
     * Set the list of actions taken for this release.
     * 
     * @param actions
     */
    public void setActions( java.util.List actions )
    {
        this.actions = actions;
    } //-- void setActions( java.util.List )

    /**
     * Set The date of this release.
     *             This field can be any String, such as "in
     * SVN" when the version isn't yet released. 
     * 
     * @param dateRelease
     */
    public void setDateRelease( String dateRelease )
    {
        this.dateRelease = dateRelease;
    } //-- void setDateRelease( String )

    /**
     * Set a short description of this release.
     * 
     * @param description
     */
    public void setDescription( String description )
    {
        this.description = description;
    } //-- void setDescription( String )

    /**
     * Set the version number associated with this release.
     * 
     * @param version
     */
    public void setVersion( String version )
    {
        this.version = version;
    } //-- void setVersion( String )


            public java.util.List getActions(String type)
            {
                java.util.List actions = new java.util.ArrayList();
                for (java.util.Iterator iterator = getActions().iterator(); iterator.hasNext(); )
                {
                  Action action = (Action) iterator.next();
                  if ( action.getType() != null && action.getType().equalsIgnoreCase( type ) )
                  {
                      actions.add( action );
                  }
                }
                return actions;
            }
          
              private final java.util.List components = new java.util.ArrayList();

              public void addComponent(String name, Release release)
              {
                  final Component component = new Component();
                  component.setName(name);
                  component.setDescription(release.getDescription());
                  component.setActions(release.getActions());
                  components.add(component);
              }

              public java.util.List getComponents()
              {
                  return components;
              }
          
}