iproperties.java

一个实用工具类

/*
 * Copyright (C) butor.com. All rights reserved.
 *
 * This software is published under the terms of the GNU Library General
 * Public License (GNU LGPL), a copy of which has been included with this
 * distribution in the LICENSE.txt file. 
 */


package org.butor.config.lowlevel;

/**
 * @version 	1.0
 * @author
 */
public interface IProperties {
	/**
	 * get a long property value.
	 * 
	 * @param key String, Name of the property to get
	 * @param defaultVal long, Default value to return if the key is
	 * 		not found in the property file
	 *
	 * @return value associated with the key
	 */
	long getPropertyLong(String key, long defaultVal);
	/**
	 * get a long property value.
	 * 
	 * @param key String, Name of the property to get
	 * @param defaultVal int, Default value to return if the key is
	 * 		not found in the property file
	 *
	 * @return value associated with the key
	 */
	int getPropertyInt(String key, int defaultVal);
	/**
	 * get a double property value.
	 * 
	 * @param key String, Name of the property to get
	 * @param defaultVal double, Default value to return if the key is
	 * 		not found in the property file
	 *
	 * @return value associated with the key
	 */
	double getPropertyDouble(String key, double defaultVal);
	/**
	 * get a boolean property value.
	 * 
	 * @param key String, Name of the property to get
	 * @param defaultVal boolean, Default value to return if the key is
	 * 		not found in the property file
	 *
	 * @return value associated with the key
	 */
	boolean getPropertyBoolean(String key, boolean defaultVal);
	/**
	 * get a String property value.
	 * 
	 * @param key String, Name of the property to get
	 * @param defaultVal String, Default value to return if the key is
	 * 		not found in the property file
	 *
	 * @return value associated with the key
	 */
	String getProperty(String key, String defaultVal);
	/**
	 * get a property key.
	 * 
	 * @param index int, property index in the list of properties.
	 *
	 * @return Object.
	 */
	Object getPropertyKey(int index);
	/**
	 * get a property value.
	 * 
	 * @param index int, property index in the list of properties.
	 *
	 * @return Object.
	 */
	Object getProperty(int index);
	/**
	 * get a property value.
	 * 
	 * @param key String, property name in the list of properties.
	 *
	 * @return Object.
	 */
	Object getProperty(String key);
	/**
	 * Get properties count.
	 * 
	 * @return int.
	 */
	int size();
	/**
	 * check if a key exists in config.
	 *
	 * @param key String, Property key
	 * 
	 * @return boolean.
	 */
	boolean existsKey(String key);
	/**
	 * Get the application directory.
	 * 
	 * @return String
	 */
	String getAppDir();
	/**
	 * Get the repository (alternate) config directory.
	 * 
	 * @return String
	 */
	String getRepositoryConfDir();
	/**
	 * Get the application config directory.
	 * 
	 * @return String
	 */
	String getConfDir();
	
	/**
	 * Get logging directory.
	 * 
	 * @return String
	 */
	String getLogDir();
	
	/**
	 * Gets the name of this IProperties object.
	 * This is useful when an IProperties object is obtained by index
	 * and we need to know its name attribute.
	 * @return
	 */
	String getName();
	/**
	 * Get a property list
	 * 
	 * @param name String, property list name
	 * 
	 * @return PropertyList
	 */
	IProperties getPropertyList(String name);
}