/*

  * 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.api.core.domain;

 import java.io.Serializable;

 import java.util.ArrayList;

 import java.util.LinkedHashMap;

 import java.util.List;

 import java.util.Map;

 import org.apache.commons.lang.StringUtils;

 /**

  * Provides comments for the values of a property.

  */

 public final class PropertyValueComment implements Serializable

 {

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

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

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

   /**

    * The class version identifier.

    * <p>

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

    * </p>

    */

   private static final long serialVersionUID = 1L;

   /**

    * The optional summary of the type of the values. May be <code>null</code>.

    *

    * @serial

    */

   private final String summary;

   /**

    * The map of values of the type to their comments.

    *

    * @serial

    */

   private final Map<Serializable, String> valueCommentMap =

       new LinkedHashMap<Serializable, String>();

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

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

   /**

    * Default constructor.

    *

    * @param summary the summary of the type of the values.

    */

   public PropertyValueComment(final String summary)

   {

     this.summary = summary;

   }

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

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

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

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

   /**

    * Returns the summary of the type of the values. May be <code>null</code>.

    *

    * @return the summary of the type of the values.

    */

   public String getSummary()

   {

     return summary;

   }

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

   /**

    * Adds the comment for the given value.

    *

    * @param value the value whose comment is to be added.

    * @param comment the comment to the value.

    */

   public void addValueComment(final Serializable value, final String comment)

   {

     valueCommentMap.put(value, comment);

   }

   /**

    * Returns the comment for the given value.

    *

    * @param value the value whose comment is requested.

    * @return the comment to the value or <code>null</code> if there is no

    *         comment for taht value.

    */

   public String getValueComment(final Serializable value)

   {

     final String comment = valueCommentMap.get(value);

     return comment;

   }

   /**

    * Returns the list of values the instance provides comments for.

    *

    * @return the list of values the instance provides comments for.

    */

   public List<Serializable> getValues()

   {

     return new ArrayList<Serializable>(valueCommentMap.keySet());

   }

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

   /**

    * Returns the string representation of the object.

    *

    * @return the string representation of the object.

    */

   @Override

   public String toString()

   {

     final StringBuilder buffer = new StringBuilder();

     if (StringUtils.isNotBlank(summary))

     {

       buffer.append(summary).append(':');

     }

     for (final Map.Entry<Serializable, String> entry : valueCommentMap

         .entrySet())

     {

       buffer.append(' ').append(entry.getKey()).append('=')

           .append(entry.getValue());

     }

     return buffer.toString();

   }

 }