/*
    * 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.NullArgumentException;
  import org.apache.commons.lang.StringUtils;
  
  import de.smartics.testdoc.core.BlankArgumentException;
  import de.smartics.util.source.MethodInfo;
  import de.smartics.util.source.SourceCodeLocation;
  
  /**
   * Provides information about a test method of a scenario.
   */
  public class TestMethodDoc implements Serializable, MethodInfo
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     */
    private static final long serialVersionUID = 1L;
  
    // --- members --------------------------------------------------------------
  
    /**
     * The name of the test. Must not be <code>null</code>.
     *
     * @serial
     */
    private final String testName;
  
    /**
     * The name of the test translated to a human readable sentence.
     *
     * @serial
     */
    private final String testSentence;
  
    /**
     * The location of the test. This is the location of the test method.
     *
     * @serial
     */
    private final SourceCodeLocation location;
  
    /**
     * The optional Javadoc comment of the test method. May be <code>null</code>.
     *
     * @serial
     * @impl If the comment contains only white-spaces or is empty, the value is
     *       silently set to <code>null</code> during construction.
     */
    private final String javadocComment;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param testName the name of the test.
     * @param testSentence the name of the test translated to a human readable
     *          sentence.
     * @param location the location of the test.
     * @param javadocComment the optional Javadoc comment of the test method. May
     *          be <code>null</code>. If it contains only whitespaces or is empty,
     *          the value is silently set to <code>null</code>.
     * @throws IllegalArgumentException if <code>testName</code> or
     *           <code>testSentence</code> is blank or <code>location</code> is
     *           <code>null</code>.
     */
    public TestMethodDoc(final String testName, final String testSentence,
        final SourceCodeLocation location, final String javadocComment)
      throws IllegalArgumentException
    {
      checkArguments(testName, testSentence, location);
  
      this.testName = testName;
     this.testSentence = testSentence;
     this.location = location;
     this.javadocComment =
         StringUtils.isBlank(javadocComment) ? null : javadocComment;
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   private static void checkArguments(final String testName,
       final String testSentence, final SourceCodeLocation location)
   {
     if (StringUtils.isBlank(testName))
     {
       throw new BlankArgumentException("testName");
     }
     if (StringUtils.isBlank(testSentence))
     {
       throw new BlankArgumentException("testSentence");
     }
     if (location == null)
     {
       throw new NullArgumentException("location");
     }
   }
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the name of the test. Must not be <code>null</code>.
    *
    * @return the name of the test.
    */
   public String getTestName()
   {
     return testName;
   }
 
   /**
    * Returns the signature of the test method. This includes the test name and
    * the parameter types list (with brackets).
    *
    * @return the signature of the test method.
    * @todo Currently assumes that the test method has no arguments.
    */
   public String getMethodSignature()
   {
     return StringUtils.isNotBlank(testName) ? testName + "()" : null;
   }
 
   /**
    * Returns the name of the test translated to a human readable sentence.
    *
    * @return the name of the test translated to a human readable sentence.
    */
   public String getTestSentence()
   {
     return testSentence;
   }
 
   /**
    * Returns the location of the test. This is the location of the test method.
    *
    * @return the location of the test.
    */
   public SourceCodeLocation getLocation()
   {
     return location;
   }
 
   /**
    * Returns the optional Javadoc comment of the test method. May be
    * <code>null</code>.
    *
    * @return the optional Javadoc comment of the test method.
    */
   public String getJavadocComment()
   {
     return javadocComment;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
   /**
    * Delegates call to {@link java.lang.String#hashCode()}.
    *
    * @return the result of the call to {@link java.lang.String#hashCode()}.
    * @see java.lang.String#hashCode()
    */
   @Override
   public int hashCode()
   {
     int result = 17;
     result = 37 * result + testName.hashCode();
 
     return result;
   }
 
   /**
    * 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 TestMethodDoc other = (TestMethodDoc) object;
 
     return (this.testName.equals(other.testName) && this.testSentence
         .equals(other.testSentence));
   }
 
   /**
    * Delegates call to {@link java.lang.StringBuilder#toString()}.
    *
    * @return the result of the call to
    *         {@link java.lang.StringBuilder#toString()}.
    * @see java.lang.StringBuilder#toString()
    */
   @Override
   public String toString()
   {
     final StringBuilder buffer = new StringBuilder();
 
     buffer.append("Test name : ").append(testName).append(", ");
     buffer.append("\nSentence  : ").append(testSentence);
     if (location != SourceCodeLocation.UNKNOWN_LOCATION)
     {
       buffer.append("\nLocation  : ").append(location);
     }
     if (javadocComment != null)
     {
       buffer.append("\nAPI      : ").append(javadocComment);
     }
     return buffer.toString();
   }
 }