/*

  * 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.util.ArrayList;

 import java.util.EnumSet;

 import java.util.List;

 import java.util.Locale;

 import de.smartics.properties.api.core.domain.PropertyValueRange;

 import de.smartics.util.lang.Arg;

 import de.smartics.util.lang.NullArgumentException;

 /**

  * A property value range backed up by an enumeration of values.

  *

  * @param <T> the type of the enumeration.

  */

 public final class EnumeratedPropertyValueRange<T extends Enum<T>> implements

     PropertyValueRange<T>

 {

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

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

   /**

    * The class version identifier.

    * <p>

    * The value of this constant is {@value}.

    * </p>

    */

   private static final long serialVersionUID = 1L;

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

   /**

    * The enumeration to provide the value for this range.

    *

    * @serial

    */

   private final Class<T> enumeration;

   /**

    * Translator that supports static <code>fromString</code> methods.

    */

   private final EnumIdTranslator<T> translator;

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

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

   /**

    * Default constructor.

    *

    * @param enumeration the enumeration to provide the value for this range.

    * @throws NullArgumentException of {code enumeration} is <code>null</code>.

    */

   public EnumeratedPropertyValueRange(final Class<T> enumeration)

     throws NullArgumentException

   {

     this.enumeration = Arg.checkNotNull("enumeration", enumeration);

     this.translator = new EnumIdTranslator<T>(enumeration);

   }

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

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

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

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

   /**

    * Returns the enumeration to provide the value for this range.

    *

    * @return the enumeration to provide the value for this range.

    */

   public Class<T> getEnumeration()

   {

     return enumeration;

   }

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

   @Override

   public List<T> getValues()

   {

     final List<T> list = new ArrayList<T>(EnumSet.allOf(enumeration));

     return list;

   }

   @Override

   public T fromString(final String valueAsString)

     throws IllegalArgumentException

   {

     return translator.fromString(valueAsString);// Enum.valueOf(enumeration,

                                                 // valueAsString);

   }

   @Override

   public boolean isCommented()

   {

     return true;

   }

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

   @Override

   public int hashCode()

   {

     return enumeration.hashCode();

   }

   @Override

   public boolean equals(final Object object)

   {

     if (this == object)

     {

       return true;

     }

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

     {

       return false;

     }

     final EnumeratedPropertyValueRange<?> other =

         (EnumeratedPropertyValueRange<?>) object;

     return (enumeration.equals(other.enumeration));

   }

   @Override

   public String toString(final Locale locale)

   {

     final StringBuilder buffer = new StringBuilder(64);

     for (T element : EnumSet.allOf(enumeration))

     {

       buffer.append(element).append(", ");

     }

     buffer.setLength(buffer.length() - 2);

     return buffer.toString();

   }

   @Override

   public String toString()

   {

     return toString(Locale.getDefault());

   }

 }