diff options
Diffstat (limited to 'base/common/src/com/netscape/cmscore/base/PropConfigStore.java')
| -rw-r--r-- | base/common/src/com/netscape/cmscore/base/PropConfigStore.java | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/base/common/src/com/netscape/cmscore/base/PropConfigStore.java b/base/common/src/com/netscape/cmscore/base/PropConfigStore.java index 1e46d3ef3..ee4370053 100644 --- a/base/common/src/com/netscape/cmscore/base/PropConfigStore.java +++ b/base/common/src/com/netscape/cmscore/base/PropConfigStore.java @@ -44,18 +44,18 @@ import com.netscape.cmsutil.util.Utils; * property names. The current property prefix is kept in * mStoreName and the mSource usually points back to another * occurance of the same PropConfigStore, with longer mStoreName. IE - * + * * <PRE> * cms.ca0.http.service0 -> mSource=PropConfigStore -> * cms.ca0.http -> mSource=PropConfigStore -> * cms.ca0 -> mSource=PropConfigStore -> * cms -> mSource=SourceConfigStore -> Properties * </PRE> - * + * * The chain ends when the store name is reduced down to it's original * value. * <P> - * + * * @version $Revision$, $Date$ */ public class PropConfigStore implements IConfigStore, Cloneable { @@ -84,7 +84,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { * be a brand new store without properties. The subclass * must be a ISourceConfigStore. * <P> - * + * * @param storeName property store name * @exception EBaseException failed to create configuration */ @@ -99,7 +99,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { * that stores all the parameters. Each substore only * store a substore name, and a reference to the source. * <P> - * + * * @param storeName store name * @param prop list of properties * @exception EBaseException failed to create configuration @@ -112,7 +112,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Returns the name of this store. * <P> - * + * * @return store name */ public String getName() { @@ -122,7 +122,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves a property from the configuration file. * <P> - * + * * @param name property name * @return property value */ @@ -134,7 +134,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { * Retrieves a property from the configuration file. Does not prepend * the config store name to the property. * <P> - * + * * @param name property name * @return property value */ @@ -147,7 +147,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { * values wont be updated to the file until save * method is invoked. * <P> - * + * * @param name property name * @param value property value */ @@ -157,7 +157,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Removes a property from the configuration file. - * + * * @param name property name */ public void remove(String name) { @@ -167,7 +167,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Returns an enumeration of the config store's keys, hidding the store * name. - * + * * @see java.util.Hashtable#elements * @see java.util.Enumeration */ @@ -180,7 +180,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves the hashtable where all the properties are kept. - * + * * @return hashtable */ public Hashtable<String, Object> hashtable() { @@ -204,7 +204,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { * Fills the given hash table with all key/value pairs in the current * config store, removing the config store name prefix * <P> - * + * * @param h the hashtable */ private synchronized void enumerate(Hashtable<String, Object> h) { @@ -226,7 +226,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Reads a config store from an input stream. - * + * * @param in input stream where properties are located * @exception IOException failed to load */ @@ -236,7 +236,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Stores this config store to the specified output stream. - * + * * @param out outputstream where the properties are saved * @param header optional header information to be saved */ @@ -246,7 +246,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves a property value. - * + * * @param name property key * @return property value * @exception EBaseException failed to retrieve value @@ -258,7 +258,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { CMS.traceHashKey(mDebugType, getFullName(name), "<notpresent>"); throw new EPropertyNotFound(CMS.getUserMessage("CMS_BASE_GET_PROPERTY_FAILED", getName() + "." + name)); } - // should we check for empty string ? + // should we check for empty string ? // if (str.length() == 0) { // throw new EPropertyNotDefined(getName() + "." + name); // } @@ -276,7 +276,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves a String from the configuration file. * <P> - * + * * @param name property name * @param defval the default object to return if name does not exist * @return property value @@ -295,7 +295,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Puts property value into this configuration store. - * + * * @param name property key * @param value property value */ @@ -306,10 +306,10 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves a byte array from the configuration file. * <P> - * + * * @param name property name * @exception IllegalArgumentException if name is not set or is null. - * + * * @return property value */ public byte[] getByteArray(String name) throws EBaseException { @@ -325,11 +325,11 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves a byte array from the configuration file. * <P> - * + * * @param name property name * @param defval the default byte array to return if name does * not exist - * + * * @return property value */ public byte[] getByteArray(String name, byte defval[]) @@ -349,7 +349,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Puts byte array into this configuration store. - * + * * @param name property key * @param value byte array */ @@ -373,7 +373,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves boolean-based property value. - * + * * @param name property key * @return boolean value * @exception EBaseException failed to retrieve @@ -401,7 +401,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves boolean-based property value. - * + * * @param name property key * @param defval default value * @return boolean value @@ -425,7 +425,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Puts boolean value into the configuration store. - * + * * @param name property key * @param value property value */ @@ -439,7 +439,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves integer value. - * + * * @param name property key * @return property value * @exception EBaseException failed to retrieve value @@ -465,7 +465,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves integer value. - * + * * @param name property key * @param defval default value * @return property value @@ -488,7 +488,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Puts an integer value. - * + * * @param name property key * @param val property value * @exception EBaseException failed to retrieve value @@ -499,7 +499,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves big integer value. - * + * * @param name property key * @return property value * @exception EBaseException failed to retrieve value @@ -529,7 +529,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves integer value. - * + * * @param name property key * @param defval default value * @return property value @@ -551,7 +551,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Puts a big integer value. - * + * * @param name property key * @param val default value */ @@ -562,7 +562,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Creates a new sub store. * <P> - * + * * @param name substore name * @return substore */ @@ -585,7 +585,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Removes a sub store. * <p> - * + * * @param name substore name */ @SuppressWarnings("unchecked") @@ -610,21 +610,21 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves a sub store. A substore contains a list * of properties and substores. For example, - * + * * <PRE> * cms.ldap.host=ds.netscape.com * cms.ldap.port=389 * </PRE> - * + * * "ldap" is a substore in above example. If the * substore property itself is set, this method * will treat the value as a reference. For example, - * + * * <PRE> * cms.ldap = kms.ldap * </PRE> * <P> - * + * * @param name substore name * @return substore */ @@ -645,7 +645,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Retrieves a list of property names. - * + * * @return a list of string-based property names */ public Enumeration<String> getPropertyNames() { @@ -674,7 +674,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Returns a list of sub store names. * <P> - * + * * @return list of substore names */ public Enumeration<String> getSubStoreNames() { @@ -704,7 +704,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { * Retrieves the source configuration store where * the properties are stored. * <P> - * + * * @return source configuration store */ public ISourceConfigStore getSourceConfigStore() { @@ -732,7 +732,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Converts the substore parameters. - * + * * @param name property name * @return fill property name */ @@ -745,7 +745,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Cloning of property configuration store. - * + * * @return a new configuration store */ public Object clone() { @@ -783,7 +783,7 @@ public class PropConfigStore implements IConfigStore, Cloneable { /** * Commits properties into the file. - * + * * @param createBackup true if create backup * @exception EBaseException failed to commit properties */ |