/**
    * Copyright By Grandsoft Company Limited.  
    * 2014-3-4 下午5:26:39
    */
   package gboat2.base.bridge.util;
   
   import gboat2.base.bridge.exception.DefaultGboatNestedException;
   
   import java.io.File;
  import java.io.FileInputStream;
  import java.io.FileNotFoundException;
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.Reader;
  import java.net.URL;
  import java.util.Properties;
  
  import org.apache.commons.configuration.ConfigurationException;
  import org.apache.commons.configuration.PropertiesConfiguration;
  import org.apache.commons.io.IOUtils;
  
  /**
   * 对 Properties 配置文件进行读写操作的工具类
   * @date 2014-3-4
   * @author <a href="mailto:[email protected]">何明旺</a>
   * @since 3.0
   */
  public class PropertiesUtil {
  
      /**
       * 加载 properties 配置文件
       * 
       * @param fileName properties 配置文件的路径，如：C:/test/1.properties
       * @return
       */
      public static Properties loadProperties(String fileName) {
          return loadProperties(new File(fileName));
      }
      
      /**
       * 加载 properties 配置文件
       * 
       * @param file properties 配置文件
       * @return
       */
      public static Properties loadProperties(File file) {
          FileInputStream input = null;
          try {
              input = new FileInputStream(file);
              return loadProperties(input);
          } catch (FileNotFoundException e) {
              throw new DefaultGboatNestedException("配置文件 [" + file.getAbsolutePath() + "] 不存在。", e);
          } finally {
              IOUtils.closeQuietly(input);
          }
      }
  
      /**
       * 加载 properties 配置文件
       * 
       * @param url properties 配置文件对应的 URL
       * @return
       */
      public static Properties loadProperties(URL url) {
          InputStream input = null;
          try {
              input = url.openStream();
              return loadProperties(input);
          } catch (IOException e) {
              throw new DefaultGboatNestedException("从 URL [" + url + "] 加载 properties 配置信息失败", e);
          } finally {
              IOUtils.closeQuietly(input);
          }
      
      }
  
      /**
       * 从资源文件中加载 properties 配置信息
       * 
       * @param resource 需要加载的 properties 资源文件的路径，如：/test/1.properties
       * @return
       */
      public static Properties loadPropertiesFromResource(String resource) {
          return loadPropertiesFromResource(resource, null);
      }
  
      
      /**
       * 通过指定的 ClassLoader 加载 properties 配置文件
       * 
       * @param resource 需要加载的 properties 资源文件的路径，如：/test/1.properties
       * @param loader 指定的 ClassLoader
       * @return
       */
      public static Properties loadPropertiesFromResource(String resource, ClassLoader loader) {
          if (loader == null) {
              loader = ClassLoader.getSystemClassLoader();
          }
          
         InputStream in = null;
         try {
             in = loader.getResourceAsStream(resource);
             return loadProperties(in);
         } finally {
             IOUtils.closeQuietly(in);
         }
     }
 
     /**
      * 从输入流加载 properties 配置信息
      * 
      * @param in 输入流
      * @return
      */
     public static Properties loadProperties(InputStream in) {
         Properties conf = new Properties();
         try {
             conf.load(in);
             return conf;
         } catch (IOException e) {
             throw new DefaultGboatNestedException("从输入流加载 properties 配置信息失败", e);
         }
     }
 
     /**
      * 从字符流加载 properties 配置信息
      * 
      * @param reader 字符流
      * @return
      */
     public static Properties loadProperties(Reader reader) {
         Properties conf = new Properties();
         try {
             conf.load(reader);
             return conf;
         } catch (IOException e) {
             throw new DefaultGboatNestedException("从字符流加载 properties 配置信息失败", e);
         }
     }
 
     /**
      * 加载 properties 配置文件
      * 
      * @param fileName properties 配置文件的路径，如：C:/test/1.properties
      * @return
      */
     public static PropertiesConfiguration LoadPropertiesConfiguration(String fileName) {
         try {
             return new PropertiesConfiguration(fileName);
         } catch (ConfigurationException e) {
             throw new DefaultGboatNestedException("从文件 [" + fileName + "] 加载 properties 配置信息失败", e);
         }
     }
     
     /**
      * 加载 properties 配置文件
      * 
      * @param file properties 配置文件
      * @return
      */
     public static PropertiesConfiguration LoadPropertiesConfiguration(File file) {
         try {
             return new PropertiesConfiguration(file);
         } catch (ConfigurationException e) {
             throw new DefaultGboatNestedException("从文件 [" + file + "] 加载 properties 配置信息失败", e);
         }
     }
 
     /**
      * 加载 properties 配置文件
      * 
      * @param url properties 配置文件对应的 URL
      * @return
      */
     public static PropertiesConfiguration LoadPropertiesConfiguration(URL url) {
         try {
             return new PropertiesConfiguration(url);
         } catch (ConfigurationException e) {
             throw new DefaultGboatNestedException("从 URL [" + url + "] 加载 properties 配置信息失败", e);
         }
     }
     
     /**
      * 从字符流加载 properties 配置信息
      * 
      * @param reader 字符流
      * @return
      */
     public static PropertiesConfiguration LoadPropertiesConfiguration(Reader reader) {
         PropertiesConfiguration conf = new PropertiesConfiguration();
         try {
             conf.load(reader);
             return conf;
         } catch (ConfigurationException e) {
             throw new DefaultGboatNestedException("从字符流加载 properties 配置信息失败", e);
         } finally {
             IOUtils.closeQuietly(reader);
         }
     }
     
     /**
      * 从输入流加载 properties 配置信息
      * 
      * @param in 输入流
      * @return
      */
     public static PropertiesConfiguration LoadPropertiesConfiguration(InputStream in) {
         return LoadPropertiesConfiguration(in, null);
     }
 
     /**
      * 从输入流加载 properties 配置信息
      * 
      * @param in 输入流
      * @return
      */
     public static PropertiesConfiguration LoadPropertiesConfiguration(InputStream in, String encoding) {
         PropertiesConfiguration conf = new PropertiesConfiguration();
         try {
             conf.load(in, encoding);
             return conf;
         } catch (ConfigurationException e) {
             throw new DefaultGboatNestedException("从输入流加载 properties 配置信息失败", e);
         }
     }
     
     /**
      * 从资源文件中加载 properties 配置信息
      * 
      * @param resource 需要加载的 properties 资源文件的路径，如：/test/1.properties
      * @return
      */
     public static PropertiesConfiguration LoadPropertiesConfigurationFromResource(String resource) {
         return LoadPropertiesConfigurationFromResource(resource, null);
     }
 
     
     /**
      * 通过指定的 ClassLoader 加载 properties 配置文件
      * 
      * @param resource 需要加载的 properties 资源文件的路径，如：/test/1.properties
      * @param loader 指定的 ClassLoader
      * @return
      */
     public static PropertiesConfiguration LoadPropertiesConfigurationFromResource(String resource, ClassLoader loader) {
         if (loader == null) {
             loader = ClassLoader.getSystemClassLoader();
         }
         
         InputStream in = null;
         try {
             in = loader.getResourceAsStream(resource);
             return LoadPropertiesConfiguration(in);
         } finally {
             IOUtils.closeQuietly(in);
         }
     }
 }