/*
    * 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.config.domain;
  
  import java.io.Serializable;
  
  import org.apache.commons.lang.ObjectUtils;
  
  import de.smartics.util.lang.Arguments;
  
  /**
   * Stores information of a property.
   */
  public class Property implements Serializable, Comparable<Property>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The optional source where the property value has been defined. This is an
     * arbitrary name that defines the origin in its context.
     *
     * @serial
     */
    private final PropertyLocation source;
  
    /**
     * The name of the property. Must not blank.
     *
     * @serial
     */
    private final String name;
  
    /**
     * The value of the property. May be <code>null</code>.
     *
     * @serial
     */
    private final String value;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param source the optional source where the property value has been
     *          defined.
     * @param name the name of the property.
     * @param value the value of the property.
     * @throws NullPointerException if {@code source} is <code>null</code>.
     * @throws IllegalArgumentException if {@code name} is blank.
     */
    public Property(final PropertyLocation source, final String name,
        final String value) throws NullPointerException, IllegalArgumentException
    {
      Arguments.checkNotNull("source", source);
      Arguments.checkNotBlank("name", name);
  
      this.source = source;
      this.name = name;
      this.value = value;
    }
  
    /**
     * Convenience constructor that translates the value to a String.
     *
     * @param source the optional source where the property value has been
     *          defined.
     * @param name the name of the property.
     * @param value the value of the property.
     * @throws IllegalArgumentException if {@code name} is blank.
     */
    public Property(final PropertyLocation source, final String name,
        final Object value) throws IllegalArgumentException
    {
      this(source, name, ObjectUtils.toString(value, null));
   }
 
   /**
    * Convenience constructor that translates the value to a String.
    *
    * @param source the optional source where the property value has been
    *          defined.
    * @param name the name of the property.
    * @param value the value of the property.
    * @throws IllegalArgumentException if {@code name} is blank.
    */
   public Property(final String source, final String name, final Object value)
     throws IllegalArgumentException
   {
     this(new PropertyLocation(source), name, ObjectUtils.toString(value, null));
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the optional source where the property value has been defined. This
    * is an arbitrary name that defines the origin in its context.
    *
    * @return the optional source where the property value has been defined.
    */
   public final PropertyLocation getSource()
   {
     return source;
   }
 
   /**
    * Returns the name of the property. Must not blank.
    *
    * @return the name of the property.
    */
   public final String getName()
   {
     return name;
   }
 
   /**
    * Returns the value of the property. May be <code>null</code>.
    *
    * @return the value of the property.
    */
   public final String getValue()
   {
     return value;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
   /**
    * {@inheritDoc}
    *
    * @see java.lang.Comparable#compareTo(java.lang.Object)
    */
   @Override
   public final int compareTo(final Property o)
   {
     int result = name.compareTo(o.name);
     if (result == 0)
     {
       result =
           ObjectUtils.compare(ObjectUtils.toString(value, null),
               ObjectUtils.toString(o.value, null));
       if (result == 0)
       {
         result = ObjectUtils.compare(source, o.source);
       }
     }
     return result;
   }
 
   /**
    * Returns the hash code of the object.
    *
    * @return the hash code.
    */
   @Override
   public final int hashCode()
   {
     return name.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 final boolean equals(final Object object)
   {
     if (this == object)
     {
       return true;
     }
     else if (object == null || getClass() != object.getClass())
     {
       return false;
     }
 
     final Property other = (Property) object;
 
     return (name.equals(other.name) && ObjectUtils.equals(value, other.value) && ObjectUtils
         .equals(source, other.source));
   }
 
   /**
    * Returns the string representation of the object.
    *
    * @return the string representation of the object.
    */
   @Override
   public String toString()
   {
     return name + '=' + value + " (" + source + ')';
   }
 }