/*

  * Copyright 2012 smartics, Kronseder & Reiner GmbH

  *

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  *     http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package de.smartics.ci.config.load;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import de.smartics.ci.config.maven.MavenConfig;

 import de.smartics.util.lang.Arguments;

 import de.smartics.util.lang.BlankArgumentException;

 import de.smartics.util.lang.NullArgumentException;

 /**

  * Allows to iterate over configurations.

  */

 public final class LoaderPlan implements Iterable<String>

 {

   // ********************************* Fields *********************************

   // --- constants ------------------------------------------------------------

   // --- members --------------------------------------------------------------

   /**

    * The information from the Maven project configuration. The Maven information

    * is applied first and may be overridden by the configuration list.

    */

   private final MavenConfig mavenConfig;

   /**

    * The identifier of the loader plan.

    */

   private final String id;

   /**

    * The names of configurations to find at a location managed by a location

    * manager.

    */

   private final List<String> configurationNames = new ArrayList<String>();

   // ****************************** Initializer *******************************

   // ****************************** Constructors ******************************

   /**

    * Default constructor.

    *

    * @param id the identifier of the loader plan.

    * @param mavenConfig the information from the Maven project configuration.

    * @throws BlankArgumentException if {@code id} is blank.

    * @throws NullArgumentException if {@code mavenConfig} is <code>null</code>.

    */

   public LoaderPlan(final String id, final MavenConfig mavenConfig)

     throws BlankArgumentException, NullArgumentException

   {

     Arguments.checkNotBlank("id", id);

     Arguments.checkNotNull("mavenConfig", mavenConfig);

     this.id = id;

     this.mavenConfig = mavenConfig;

   }

   // ****************************** Inner Classes *****************************

   // ********************************* Methods ********************************

   // --- init -----------------------------------------------------------------

   // --- get&set --------------------------------------------------------------

   /**

    * Returns the identifier of the loader plan.

    *

    * @return the identifier of the loader plan.

    */

   public String getId()

   {

     return id;

   }

   /**

    * Returns the information from the Maven project configuration.

    *

    * @return the information from the Maven project configuration.

    */

   public MavenConfig getMavenConfig()

   {

     return mavenConfig;

   }

   // --- business -------------------------------------------------------------

   /**

    * Adds a configuration name to the loader plan.

    *

    * @param configurationName the name to add.

    * @throws BlankArgumentException if {@code configurationName} is blank.

    */

   public void addConfigurationName(final String configurationName)

     throws BlankArgumentException

   {

     Arguments.checkNotBlank("configurationName", configurationName);

     configurationNames.add(configurationName);

   }

   /**

    * {@inheritDoc}

    *

    * @see java.lang.Iterable#iterator()

    */

   @Override

   public Iterator<String> iterator()

   {

     return configurationNames.iterator();

   }

   /**

    * Checks if the loader plan contains at least on name.

    *

    * @return <code>false</code> if the loader plan contains at least one name,

    *         <code>true</code> if it is empty.

    */

   public boolean isEmpty()

   {

     return configurationNames.isEmpty();

   }

   // --- object basics --------------------------------------------------------

   /**

    * Returns the hash code of the object.

    *

    * @return the hash code.

    */

   @Override

   public int hashCode()

   {

     return id.hashCode();

   }

   /**

    * Returns <code>true</code> if the given object is semantically equal to the

    * given object, <code>false</code> otherwise.

    * <p>

    * The Maven configuration is not a part of the check.

    * </p>

    *

    * @param object the instance to compare to.

    * @return <code>true</code> if the given object is semantically equal to the

    *         given object, <code>false</code> otherwise.

    */

   @Override

   public boolean equals(final Object object)

   {

     if (this == object)

     {

       return true;

     }

     else if (object == null || getClass() != object.getClass())

     {

       return false;

     }

     final LoaderPlan other = (LoaderPlan) object;

     return (id.equals(other.id) && configurationNames

         .equals(other.configurationNames));

   }

   /**

    * {@inheritDoc}

    *

    * @see java.lang.Object#toString()

    */

   @Override

   public String toString()

   {

     final StringBuilder buffer = new StringBuilder(64);

     buffer.append(id).append(": ");

     for (final String configurationName : configurationNames)

     {

       buffer.append(configurationName).append(' ');

     }

     buffer.append(mavenConfig);

     return buffer.toString();

   }

 }