/*
    * Copyright 2007-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.maven.exceptions.conf;
  
  import java.io.File;
  import java.util.ArrayList;
  import java.util.Collection;
  
  import org.apache.commons.lang.StringUtils;
  
  import de.smartics.maven.exceptions.util.FileNameUtils;
  
  
  /**
   * This class provides utilities to discover source files.
   */
  public final class ConfigUtils
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    private ConfigUtils()
    {
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * Checks each name if it references a library and if this is the case tries
     * to find a source archive for the class archive.
     *
     * @param classRootDirectoryNames the root directory names for the class
     *          archives (may be directories or files).
     * @return the collection of source archives found for the given class
     *         archives.
     */
    public static Collection<String> discoverSourceJars(
        final Collection<String> classRootDirectoryNames)
    {
      final Collection<String> sourceRootDirectoryNames =
          new ArrayList<String>(classRootDirectoryNames.size());
  
      for (String classRootDirectoryName : classRootDirectoryNames)
      {
        if (FileNameUtils.isArchive(classRootDirectoryName))
        {
          final String sourceRootDirectoryName =
              discoverSourceDirectory(classRootDirectoryName);
          if (sourceRootDirectoryName != null)
          {
            sourceRootDirectoryNames.add(sourceRootDirectoryName);
          }
        }
      }
  
      return sourceRootDirectoryNames;
    }
  
    /**
     * Dispatches the given name and tries to find a source directory for it.
     *
     * @param classRootDirectoryName the name that references an archive with
     *          classes.
     * @return the name of an existing source archive or <code>null</code> if no
     *         such archive has been found.
     * @throws NullPointerException if the argument is <code>null</code>.
     */
    public static String discoverSourceDirectory(
       final String classRootDirectoryName) throws NullPointerException
   {
     final int index = classRootDirectoryName.lastIndexOf('.');
 
     if (index >= 0 && index < classRootDirectoryName.length() - 1)
     {
       final String stem = classRootDirectoryName.substring(0, index);
       File file = new File(stem + "-sources.jar");
       if (file.exists())
       {
         return file.getAbsolutePath();
       }
 
       file = new File(stem + "-sources.zip");
       if (file.exists())
       {
         return file.getAbsolutePath();
       }
     }
 
     return null;
   }
 
   /**
    * Checks that the {@link String} value is provided. If not, the given message
    * will be appended to the given buffer.
    *
    * @param buffer the buffer to append the <code>message</code> to, if
    *          <code>value</code> is blank.
    * @param value the value that must not be blank.
    * @param message the validation failure message.
    */
   public static void checkStringValueProvided(
       final StringBuilder buffer,
       final String value,
       final String message)
   {
     if (StringUtils.isBlank(value))
     {
       buffer.append('\n').append(message);
     }
   }
 
   /**
    * Checks that the {@link Object} value is provided. If not, the given message
    * will be appended to the given buffer.
    *
    * @param buffer the buffer to append the <code>message</code> to, if
    *          <code>value</code> is <code>null</code>.
    * @param value the value that must not be <code>null</code>.
    * @param message the validation failure message.
    */
   public static void checkValueProvided(
       final StringBuilder buffer,
       final Object value,
       final String message)
   {
     if (value == null)
     {
       buffer.append('\n').append(message);
     }
   }
 
   /**
    * Checks that the {@link Collection} value is provided. If not, the given
    * message will be appended to the given buffer.
    *
    * @param buffer the buffer to append the <code>message</code> to, if
    *          <code>value</code> is <code>null</code> or empty.
    * @param value the value that must not be <code>null</code> or empty.
    * @param message the validation failure message.
    */
   public static void checkCollectionValueProvided(
       final StringBuilder buffer,
       final Collection<?> value,
       final String message)
   {
     if (value == null || value.isEmpty())
     {
       buffer.append('\n').append(message);
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }