/*
    * Copyright 2011-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.recode;
  
  import java.io.File;
  
  import org.codehaus.plexus.util.StringUtils;
  
  /**
   * Describes a resource folder.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public class Resources
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The directory containing the resources.
     */
    private File dir;
  
    /**
     * The source encoding of the resources.
     */
    private String sourceEncoding;
  
    /**
     * The target encoding of the resources.
     */
    private String targetEncoding;
  
    /**
     * The files within <code>dir</code> to be included. If not specified all
     * files in that directory are included.
     */
    private String[] includes;
  
    /**
     * The files within <code>dir</code> to be excluded. If not specified no file
     * in that directory is excluded.
     */
    private String[] excludes;
  
    /**
     * The flag indicates whether <code>\r\n</code> are to be translated to
     * <code>\n</code>.
     */
    private Boolean fromDos;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    public Resources()
    {
  
    }
  
    /**
     * Convenience constructor.
     *
     * @param dir the directory containing the resources.
     */
    public Resources(final File dir)
    {
      this.dir = dir;
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    /**
    * Returns the directory containing the resources.
    *
    * @return the directory containing the resources.
    */
   public File getDir()
   {
     return dir;
   }
 
   /**
    * Returns the source encoding of the resources.
    *
    * @return the source encoding of the resources.
    */
   public String getSourceEncoding()
   {
     return sourceEncoding;
   }
 
   /**
    * Returns the target encoding of the resources.
    *
    * @return the target encoding of the resources.
    */
   public String getTargetEncoding()
   {
     return targetEncoding;
   }
 
   /**
    * Returns the files within <code>dir</code> to be included. If not specified
    * all files in that directory are included.
    *
    * @return the files within <code>dir</code> to be included.
    */
   public String[] getIncludes()
   {
     return includes; // NOPMD
   }
 
   /**
    * Returns the files within <code>dir</code> to be excluded. If not specified
    * no file in that directory is excluded.
    *
    * @return the files within <code>dir</code> to be excluded.
    */
   public String[] getExcludes()
   {
     return excludes; // NOPMD
   }
 
   /**
    * Returns the flag indicates whether <code>\r\n</code> are to be translated
    * to <code>\n</code>. Defaults to <code>false</code>.
    *
    * @return the flag indicates whether <code>\r\n</code> are to be translated
    *         to <code>\n</code>.
    */
   public boolean isFromDos()
   {
     return fromDos != null ? fromDos : false;
   }
 
   // --- business -------------------------------------------------------------
 
   /**
    * Sets default if not already set.
    *
    * @param sourceEncoding the source encoding of the resources.
    * @param targetEncoding the target encoding of the resources.
    * @param fromDos the flag indicates whether <code>\r\n</code> are to be
    *          translated to <code>\n</code>.
    */
   public void setDefaults(final String sourceEncoding,
       final String targetEncoding, final boolean fromDos)
   {
     if (StringUtils.isBlank(this.sourceEncoding))
     {
       this.sourceEncoding = sourceEncoding;
     }
     if (StringUtils.isBlank(this.targetEncoding))
     {
       this.targetEncoding = targetEncoding;
     }
     if (this.fromDos == null)
     {
       this.fromDos = fromDos;
     }
 
     if (dir == null)
     {
       throw new IllegalStateException(
           "Directory of resource descriptor is required.");
     }
   }
 
   // --- 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 (dir != null)
     {
       buffer.append(dir.getAbsolutePath());
     }
     append(buffer, "includes", includes);
     append(buffer, "excludes", excludes);
     buffer.append(": ").append(sourceEncoding).append("->")
         .append(targetEncoding);
     buffer.append(" (fromDos: ").append(fromDos).append(')');
 
     return buffer.toString();
   }
 
   private static void append(final StringBuilder buffer, final String id,
       final String[] items)
   {
     if (items != null)
     {
       buffer.append(" (").append(id).append(": ");
       for (final String item : items)
       {
         buffer.append(item);
       }
       buffer.append(')');
     }
   }
 }