/*
    * Copyright 2012-2013 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.properties.spi.config.support;
  
  import java.util.Collection;
  import java.util.Iterator;
  import java.util.LinkedHashMap;
  import java.util.Map;
  import java.util.Map.Entry;
  import java.util.Set;
  
  import javax.annotation.concurrent.NotThreadSafe;
  
  import de.smartics.properties.api.config.domain.Property;
  import de.smartics.properties.api.config.domain.PropertyCollection;
  import de.smartics.properties.api.config.domain.PropertyLocation;
  import de.smartics.util.lang.Arg;
  
  /**
   * Implementation of {@link PropertyCollection} based on a {@link Map}.
   */
  @NotThreadSafe
  public final class MappedPropertyCollection implements PropertyCollection
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The properties to iterate over.
     */
    private final Map<String, String> properties =
        new LinkedHashMap<String, String>();
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Constructor to add properties via a collection.
     * <p>
     * The contents of the {@code properties} are added. The client may use the
     * {@code properties} continuously for other purposes since no reference is
     * held to any of the {@code properties} after the call.
     * </p>
     *
     * @param properties the properties to iterate over.
     */
    public MappedPropertyCollection(
        final Collection<Map<String, String>> properties)
    {
      Arg.checkNotNull("properties", properties); // NOPMD
  
      for (final Map<String, String> element : properties)
      {
        this.properties.putAll(element);
      }
    }
  
    /**
     * Constructor to add properties.
     * <p>
     * The contents of the {@code properties} is added. The client may use the
     * {@code properties} continuously for other purposes since no reference is
     * held to the {@code properties} after the call.
     * </p>
     *
     * @param properties the properties to iterate over.
     */
    public MappedPropertyCollection(final Map<String, String> properties)
    {
      Arg.checkNotNull("properties", properties);
  
      this.properties.putAll(properties);
    }
  
    /**
     * Constructor to add properties.
     * <p>
     * The contents of the {@code properties} are added. The client may use the
     * {@code properties} continuously for other purposes since no reference is
     * held to any of the {@code properties} after the call.
     * </p>
     *
    * @param properties the properties to iterate over.
    */
   public MappedPropertyCollection(final Map<String, String>... properties)
   {
     Arg.checkNotNull("properties", properties);
 
     for (final Map<String, String> element : properties)
     {
       this.properties.putAll(element);
     }
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    *
    * @see java.lang.Iterable#iterator()
    */
   @Override
   public Iterator<Property> iterator()
   {
     final Set<Entry<String, String>> entrySet = properties.entrySet();
     final Iterator<Entry<String, String>> i = entrySet.iterator();
     // CHECKSTYLE:OFF
     return new Iterator<Property>() // NOPMD CHECKSTYLE:ON
     {
       @Override
       public boolean hasNext()
       {
         return i.hasNext();
       }
 
       @Override
       public Property next()
       {
         final Entry<String, String> entry = i.next();
         final Object value = entry.getValue();
 
         if (value instanceof Property)
         {
           return (Property) value;
         }
         else
         {
           return new Property(new PropertyLocation(getClass().getName()),
               entry.getKey(), entry.getValue());
         }
       }
 
       @Override
       public void remove()
       {
         throw new UnsupportedOperationException("Remove not supported.");
       }
     };
   }
 
   @Override
   public void close()
   {
   }
 
   // --- object basics --------------------------------------------------------
 
 }