/*
    * Copyright 2010-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.testdoc.core.doc;
  
  import java.io.Serializable;
  
  import org.apache.commons.lang.ObjectUtils;
  import org.apache.commons.lang.StringUtils;
  
  /**
   * Stores the package and type name of a UUT type name.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public final class Type implements Serializable, Comparable<Type>
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The package part of the type name.
     *
     * @serial
     */
    private final String packageName;
  
    /**
     * The name of the type without the package part.
     *
     * @serial
     */
    private final String typeName;
  
    /**
     * The pre-calculated hash code.
     *
     * @serial
     */
    private final int preCalcHashCode;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param type the type as a string.
     * @throws IllegalArgumentException if <code>type</code> is blank or has a dot
     *           at the end.
     */
    public Type(final String type)
    {
      checkArguments(type);
      final int index = type.lastIndexOf('.');
      if (index != -1)
      {
        packageName = type.substring(0, index);
        typeName = type.substring(index + 1);
      }
      else
      {
        packageName = null;
        typeName = type;
      }
  
      preCalcHashCode = calculateHashCode();
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    private static void checkArguments(final String type)
    {
     if (StringUtils.isBlank(type))
     {
       throw new IllegalArgumentException("The type must not be blank.");
     }
     if (type.endsWith("."))
     {
       throw new IllegalArgumentException(
           "The type is not valid. It ends with a dot: " + type);
     }
   }
 
   private int calculateHashCode()
   {
     int result = 17;
     result = 37 * result + ObjectUtils.hashCode(packageName);
     result = 37 * result + ObjectUtils.hashCode(typeName);
 
     return result;
   }
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the package part of the type name.
    *
    * @return the package part of the type name.
    */
   public String getPackageName()
   {
     return packageName;
   }
 
   /**
    * Returns the name of the type without the package part.
    *
    * @return the name of the type without the package part.
    */
   public String getTypeName()
   {
     return typeName;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
   /**
    * {@inheritDoc}
    * <p>
    * Defines the lexicographical order on packages and type names.
    * </p>
    *
    * @param other the other instance to compare to.
    */
   @Override
   public int compareTo(final Type other)
   {
     int compare = 0;
     if (packageName != null)
     {
       if (other.packageName != null)
       {
         compare = packageName.compareTo(other.packageName);
       }
       else
       {
         compare = 1;
       }
     }
     else
     {
       if (other.packageName != null)
       {
         compare = -1;
       }
     }
 
     if (compare == 0)
     {
       compare = typeName.compareTo(other.typeName);
     }
 
     return compare;
   }
 
   /**
    * Returns the hash code of the object.
    *
    * @return the hash code.
    */
   @Override
   public int hashCode()
   {
     return preCalcHashCode;
   }
 
   /**
    * 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 Type other = (Type) object;
 
     return (ObjectUtils.equals(packageName, other.packageName) && typeName
         .equals(other.typeName));
   }
 
   /**
    * Returns the string representation of the object.
    *
    * @return the string representation of the object.
    */
   @Override
   public String toString()
   {
     return (packageName != null ? packageName + '.' : "") + typeName;
   }
 }