Open Source Repository

Home /mail/mail-1.4.3 | Repository Home



com/sun/mail/util/PropUtil.java
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2008 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 *
 * Contributor(s):
 *
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.mail.util;

import java.util.*;
import javax.mail.Session;

/**
 * Utilities to make it easier to get property values.
 * Properties can be strings or type-specific value objects.
 *
 @author Bill Shannon
 */
public class PropUtil {

    // No one should instantiate this class.
    private PropUtil() {
    }

    /**
     * Get an integer valued property.
     */
    public static int getIntProperty(Properties props, String name, int def) {
  return getInt(props.get(name), def);
    }

    /**
     * Get a boolean valued property.
     */
    public static boolean getBooleanProperty(Properties props,
        String name, boolean def) {
  return getBoolean(props.get(name), def);
    }

    /**
     * Get an integer valued property.
     */
    public static int getIntSessionProperty(Session session,
        String name, int def) {
  return getInt(session.getProperties().get(name), def);
    }

    /**
     * Get a boolean valued property.
     */
    public static boolean getBooleanSessionProperty(Session session,
        String name, boolean def) {
  return getBoolean(session.getProperties().get(name), def);
    }

    /**
     * Get a boolean valued System property.
     */
    public static boolean getBooleanSystemProperty(String name, boolean def) {
  try {
      return getBoolean(System.getProperties().get(name), def);
  catch (SecurityException sex) {
      // fall through...
  }

  /*
   * If we can't get the entire System Properties object because
   * of a SecurityException, just ask for the specific property.
   */
  try {
      String value = System.getProperty(name);
      if (value == null)
    return def;
      if (def)
    return !value.equalsIgnoreCase("false");
      else
    return value.equalsIgnoreCase("true");
  catch (SecurityException sex) {
      return def;
  }
    }

    /**
     * Interpret the value object as an integer,
     * returning def if unable.
     */
    private static int getInt(Object value, int def) {
  if (value == null)
      return def;
  if (value instanceof String) {
      try {
    return Integer.parseInt((String)value);
      catch (NumberFormatException nfex) { }
  }
  if (value instanceof Integer)
      return ((Integer)value).intValue();
  return def;
    }

    /**
     * Interpret the value object as a boolean,
     * returning def if unable.
     */
    private static boolean getBoolean(Object value, boolean def) {
  if (value == null)
      return def;
  if (value instanceof String) {
      /*
       * If the default is true, only "false" turns it off.
       * If the default is false, only "true" turns it on.
       */
      if (def)
    return !((String)value).equalsIgnoreCase("false");
      else
    return ((String)value).equalsIgnoreCase("true");
  }
  if (value instanceof Boolean)
      return ((Boolean)value).booleanValue();
  return def;
    }
}