package com.explosion.utilities;
   
   /*
    * =============================================================================
    * 
    * Copyright 2004 Stephen Cowx
    * 
    * 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.
   * 
   * =============================================================================
   */
  
  /***
   * This is a utility class to handle all properties related functions
   */
  
  import java.awt.Font;
  import java.io.File;
  import java.io.FileInputStream;
  import java.io.IOException;
  import java.io.InputStream;
  import java.util.Enumeration;
  import java.util.Properties;
  
  import javax.swing.JFrame;
  
  import org.apache.log4j.LogManager;
  import org.apache.log4j.Logger;
  
  public class PropertiesUtils extends Exception
  {
  
      private static Logger log = LogManager.getLogger(PropertiesUtils.class);
  
      /***
       * This method will load a properties file from a given location and return
       * that properties object to the caller.
       */
      public static Properties loadProperties(String filePath) throws Exception
      {
          Properties properties = new Properties();
          if (filePath == null)
              throw new Exception("Preferences path supplied to load properties is null.");
  
          File file = new File(filePath);
          if (file.exists())
          {
              if (file.isDirectory())
                  throw new Exception("The properties path '" + filePath + "' supplied is a directory and not a file.");
  
              properties.load(new FileInputStream(file));
          }
          else
              return new Properties();
  
          return properties;
      }
  
      /***
       * Loads a property set with the given name up from the classpath
       * 
       * @throws IOException
       */
      public static Properties loadPropertiesFromClasspath(String name, ClassLoader loader) throws Exception
      {
          Properties properties = new Properties();
          InputStream stream =  loader.getResourceAsStream(name);
          if (stream == null)
              throw new Exception("Unable to lead properties '"+name+"' from the classpath.");
          properties.load(loader.getResourceAsStream(name));
          return properties;
      }
      
      /***
       * Loads a property set with the given name up from the classpath
       * 
       * @throws IOException
       */
      public static Properties loadPropertiesFromClasspath(String name) throws Exception
      {
         return loadPropertiesFromClasspath(name, name.getClass().getClassLoader());
      }
  
      /***
       * This method extracts a subset of properties with the prefix provided from
       * the properties object provided.  The names of the resulting properties 
       * are sunstringed to exclude the prefix 
       * 
       * @param prefix
      * @param properties
      * @return
      */
     public static Properties subset(String prefix, Properties properties)
     {
         Properties newProperties = new Properties();
         Enumeration e = properties.propertyNames();
         while (e.hasMoreElements())
         {
             String itemName = (String) e.nextElement();
             if (itemName.startsWith(prefix))
                newProperties.put(itemName.substring(prefix.length(), itemName.length()), properties.getProperty(itemName).trim());
         }
         return newProperties;
     }
 
     /***
      * This method appends one set of properties to another.
      * 
      * @param appendFrom
      * @param appendTo
      * @throws InvalidCOnfigurationException if one of the properties already
      *         exists
      */
     private static void append(Properties appendFrom, Properties appendTo)
     {
         Enumeration e = appendFrom.propertyNames();
         while (e.hasMoreElements())
         {
             String itemName = (String) e.nextElement();
             appendTo.put(itemName, appendFrom.getProperty(itemName).trim());
         }
     }
 
     /***
      * This method returns a properties path. Of the format
      * "[user.home]/.[prefix]/[prefix].prop" If te directory does not exist, it
      * will create it.
      */
     public static String getStandardPropertiesPath(String prefix)
     {
         File propertiesDirectory = new File(System.getProperty("user.home") + System.getProperty("file.separator") + "." + prefix);
         if (!propertiesDirectory.exists())
             propertiesDirectory.mkdir();
 
         return System.getProperty("user.home") + System.getProperty("file.separator") + "." + prefix + System.getProperty("file.separator") + prefix + ".properties";
     }
 
     /***
      * Returns a font from the properties object if there is one or a default
      * ifthere isnt
      * 
      * @deprecated does nothing
      */
     public static Font getPropertiesFont(Properties properties)
     {
         log.debug("getPropertiesFont has been called andis not correctly implemented");
         //int style =
         // Integer.parseInt(properties.getProperty(Constants.FONTSTYLE, (new
         // Integer(Font.PLAIN)).toString()));
         //int size =
         // Integer.parseInt(properties.getProperty(Constants.FONTSIZE, "12"));
         //String name = properties.getProperty(Constants.FONTNAME, "Times New
         // Roman");
         return null;//new Font(name, style, size);
     }
 
     /***
      * This method sets the frame size of the given frame. <br>
      * If the property ExpConstants.STARTMAXIMISED is true then it will start
      * maximised <br>
      * otherwise it will set the frame size to the sizes given by the properties
      * ExpConstants.HEIGHT and ExpConstants.WIDTH <br>
      * if these are notfoundthenitwilldefaulttothedefaultsizesprovided
      * 
      * @deprecated does nothing
      */
     public static void setFrameSizeFromProperties(Properties properties, JFrame frame, String defaultHeight, String defaultWidth) throws Exception
     {
     //    if (properties.getProperty(ExpConstants.STARTMAXIMISED,
     // ExpConstants.FALSE).equalsIgnoreCase(ExpConstants.TRUE))
     //    {
     //      frame.setSize(Toolkit.getDefaultToolkit().getScreenSize());
     //    }
     //    else
     //    {
     //      int heightOfIt = (new
     // Double(properties.getProperty(ExpConstants.HEIGHT,
     // defaultHeight))).intValue() - 15;
     //      int widthOfIt = (new Double(properties.getProperty(ExpConstants.WIDTH,
     // defaultWidth))).intValue() - 15;
     //      frame.setSize(new Dimension(widthOfIt, heightOfIt));
     //    }
     }
 
 }