/*
    * 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.core.value;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.LinkedHashMap;
  import java.util.List;
  import java.util.Locale;
  import java.util.Map;
  
  import de.smartics.properties.api.core.domain.PropertyValueRange;
  import de.smartics.util.lang.Arg;
  import de.smartics.util.lang.NullArgumentException;
  
  /**
   * Defines a set of valid enumerable elements for values of a property.
   *
   * @param <T> the type of the property values within the given range. Please
   *          note that the type is required to be serializable. Otherwise
   *          instances of this class are also not serializable.
   */
  public final class CollectionPropertyValueRange<T> implements
      PropertyValueRange<T>, Serializable
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The values mapped by their string representation to their value instance.
     *
     * @serial
     */
    private final Map<String, T> valueRange;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Constructor accepting an array of values.
     *
     * @param values the allowed values for this value range.
     * @throws NullArgumentException if {@code values} is <code>null</code>.
     */
    public CollectionPropertyValueRange(final T[] values)
      throws NullArgumentException
    {
      Arg.checkNotNull("values", values);
      this.valueRange = createMap(values);
    }
  
    /**
     * Constructor accepting a collection of values.
     *
     * @param values the allowed values for this value range.
     * @throws NullArgumentException if {@code values} is <code>null</code>.
     */
    public CollectionPropertyValueRange(final Collection<T> values)
      throws NullArgumentException
    {
      Arg.checkNotNull("values", values);
      this.valueRange = createMap(values);
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    private static <T> Map<String, T> createMap(final T[] values)
    {
      final Map<String, T> map = new LinkedHashMap<String, T>(values.length);
      for (T value : values)
      {
        map.put(String.valueOf(value), value);
     }
     return map;
   }
 
   private static <T> Map<String, T> createMap(final Collection<T> values)
   {
     final Map<String, T> map = new LinkedHashMap<String, T>(values.size());
     for (T value : values)
     {
       map.put(String.valueOf(value), value);
     }
     return map;
   }
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   @Override
   public List<T> getValues()
   {
     final List<T> list = new ArrayList<T>(valueRange.values());
     return list;
   }
 
   @Override
   public T fromString(final String valueAsString)
     throws IllegalArgumentException
   {
     final T value = valueRange.get(valueAsString);
     if (value != null)
     {
       return value;
     }
     else
     {
       throw new IllegalArgumentException(
           "The value '" + valueAsString
               + "' is not a valid value. Valid values are "
               + valueRange.values());
     }
   }
 
   @Override
   public boolean isCommented()
   {
     return false;
   }
 
   // --- object basics --------------------------------------------------------
 
   /**
    * Returns the hash code of the object.
    *
    * @return the hash code.
    */
   @Override
   public int hashCode()
   {
     return valueRange.hashCode();
   }
 
   /**
    * Returns <code>true</code> if the given object is semantically equal to the
    * given object, <code>false</code> otherwise.
    *
    * @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 CollectionPropertyValueRange<?> other =
         (CollectionPropertyValueRange<?>) object;
 
     return (valueRange.equals(other.valueRange));
   }
 
   @Override
   public String toString(final Locale locale)
   {
     final StringBuilder buffer = new StringBuilder(64);
     for (String value : valueRange.keySet())
     {
       buffer.append(value).append(", ");
     }
 
     final int length = buffer.length();
     if (length > 0)
     {
       buffer.setLength(length - 2);
     }
 
     return buffer.toString();
   }
 
   @Override
   public String toString()
   {
     return toString(Locale.getDefault());
   }
 }