org.apache.maven.continuum.xmlrpc.project.AddingResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of continuum-xmlrpc-api Show documentation
The newest version!
/*
 =================== DO NOT EDIT THIS FILE ====================
 Generated by Modello
 any modifications will be overwritten.
 ==============================================================
 */

package org.apache.maven.continuum.xmlrpc.project;

  //---------------------------------/
 //- Imported classes and packages -/
//---------------------------------/

import org.apache.continuum.xmlrpc.release.ContinuumReleaseResult;
import org.apache.continuum.xmlrpc.repository.AbstractPurgeConfiguration;
import org.apache.continuum.xmlrpc.repository.DirectoryPurgeConfiguration;
import org.apache.continuum.xmlrpc.repository.LocalRepository;
import org.apache.continuum.xmlrpc.repository.RepositoryPurgeConfiguration;
import org.apache.continuum.xmlrpc.utils.BuildTrigger;
import org.apache.maven.continuum.xmlrpc.scm.ChangeFile;
import org.apache.maven.continuum.xmlrpc.scm.ChangeSet;
import org.apache.maven.continuum.xmlrpc.scm.ScmResult;
import org.apache.maven.continuum.xmlrpc.system.Installation;
import org.apache.maven.continuum.xmlrpc.system.Profile;
import org.apache.maven.continuum.xmlrpc.system.SystemConfiguration;

/**
 * 
 *         This class is the result of add maven project action.
 *       
 * 
 * @version $Revision$ $Date$
 */
@SuppressWarnings( "all" )
public class AddingResult
    implements java.io.Serializable
{

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

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

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


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

    /**
     * Method addProject.
     * 
     * @param projectSummary
     */
    public void addProject( ProjectSummary projectSummary )
    {
        getProjects().add( projectSummary );
    } //-- void addProject( ProjectSummary )

    /**
     * Method addProjectGroup.
     * 
     * @param projectGroupSummary
     */
    public void addProjectGroup( ProjectGroupSummary projectGroupSummary )
    {
        getProjectGroups().add( projectGroupSummary );
    } //-- void addProjectGroup( ProjectGroupSummary )

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

        return this.projectGroups;
    } //-- java.util.List getProjectGroups()

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

        return this.projects;
    } //-- java.util.List getProjects()

    /**
     * Method removeProject.
     * 
     * @param projectSummary
     */
    public void removeProject( ProjectSummary projectSummary )
    {
        getProjects().remove( projectSummary );
    } //-- void removeProject( ProjectSummary )

    /**
     * Method removeProjectGroup.
     * 
     * @param projectGroupSummary
     */
    public void removeProjectGroup( ProjectGroupSummary projectGroupSummary )
    {
        getProjectGroups().remove( projectGroupSummary );
    } //-- void removeProjectGroup( ProjectGroupSummary )

    /**
     * Set the projectGroups field.
     * 
     * @param projectGroups
     */
    public void setProjectGroups( java.util.List projectGroups )
    {
        this.projectGroups = projectGroups;
    } //-- void setProjectGroups( java.util.List )

    /**
     * Set the projects field.
     * 
     * @param projects
     */
    public void setProjects( java.util.List projects )
    {
        this.projects = projects;
    } //-- void setProjects( java.util.List )

    
            private java.util.List errors = new java.util.ArrayList();

            /**
             * Add an error that happened during adding the project to Continuum.
             *
             * @param errorKey error id (so it can be internationalized later)
             */
            public void addError( String errorKey )
            {
                errors.add( errorKey );
            }

            /**
             * Get the errors that happened during adding the project to Continuum.
             * There is an entry with the error key (so it can be internationalized later) for each error.
             *
             * @return {@link java.util.List} < {@link String} >
             */
            public java.util.List getErrors()
            {
                return errors;
            }

            /**
             * Quick check to see if there are any errors.
             *
             * @return boolean indicating if there are any errors.
             */
            public boolean hasErrors()
            {
                return ( errors != null ) && ( !errors.isEmpty() );
            }

            /**
             * Returns a string representation of the errors.
             *
             * @return a string representation of the errors.
             */
            public String getErrorsAsString()
            {
                if ( !hasErrors() )
                {
                    return null;
                }

                StringBuffer message = new StringBuffer();
                for ( java.util.Iterator i = errors.iterator(); i.hasNext(); )
                {
                    String error = (String) i.next();
                    message.append( error );
                    message.append( "\n" );
                }
                return message.toString();
            }
          
}