diff options
Diffstat (limited to 'base/common/src/com/netscape/certsrv/base/IConfigStore.java')
| -rw-r--r-- | base/common/src/com/netscape/certsrv/base/IConfigStore.java | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/base/common/src/com/netscape/certsrv/base/IConfigStore.java b/base/common/src/com/netscape/certsrv/base/IConfigStore.java index d12265e83..d96fddb05 100644 --- a/base/common/src/com/netscape/certsrv/base/IConfigStore.java +++ b/base/common/src/com/netscape/certsrv/base/IConfigStore.java @@ -26,7 +26,7 @@ import java.util.Enumeration; * to keep arbitrary data indexed by string names. * <p> * In the following example: - * + * * <pre> * param1=value1 * configStore1.param11=value11 @@ -35,27 +35,27 @@ import java.util.Enumeration; * configStore1.subStore1.param112=value112 * configStore2.param21=value21 * </pre> - * + * * The top config store has parameters <i>param1</i> and sub-stores <i>configStore1</i> and <i>configStore2</i>. <br> * The following illustrates how a config store is used. - * + * * <pre> - * // the top config store is passed to the following method. + * // the top config store is passed to the following method. * public void init(IConfigStore config) throws EBaseException { * IConfigStore store = config; * String valx = config.getString("param1"); * // valx is "value1" <p> - * + * * IConfigStore substore1 = config.getSubstore("configStore1"); * String valy = substore1.getString("param11"); * // valy is "value11" <p> - * + * * IConfigStore substore2 = config.getSubstore("configStore2"); * String valz = substore2.getString("param21"); * // valz is "value21" <p> * } * </pre> - * + * * @version $Revision$, $Date$ */ public interface IConfigStore extends ISourceConfigStore { @@ -63,7 +63,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Gets the name of this Configuration Store. * <P> - * + * * @return The name of this Configuration store */ public String getName(); @@ -71,7 +71,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrieves the value of the given property as a string. * <p> - * + * * @param name The name of the property to get * @return The value of the property as a String * @exception EPropertyNotFound If the property is not present @@ -84,7 +84,7 @@ public interface IConfigStore extends ISourceConfigStore { * Retrieves the value of a given property as a string or the * given default value if the property is not present. * <P> - * + * * @param name The property to retrive * @param defval The default value to return if the property is not present * @return The roperty value as a string @@ -96,7 +96,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Stores a property and its value as a string. * <p> - * + * * @param name The name of the property * @param value The value as a string */ @@ -105,7 +105,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrieves the value of a property as a byte array. * <P> - * + * * @param name The property name * @return The property value as a byte array * @exception EPropertyNotFound If the property is not present @@ -118,7 +118,7 @@ public interface IConfigStore extends ISourceConfigStore { * Retrieves the value of a property as a byte array, using the * given default value if property is not present. * <P> - * + * * @param name The name of the property * @param defval The default value if the property is not present. * @return The property value as a byte array. @@ -130,7 +130,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Stores the given property and value as a byte array. * <p> - * + * * @param name The property name * @param value The value as a byte array to store */ @@ -139,7 +139,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrieves the given property as a boolean. * <P> - * + * * @param name The name of the property as a string. * @return The value of the property as a boolean. * @exception EPropertyNotFound If the property is not present @@ -151,7 +151,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrieves the given property as a boolean. * <P> - * + * * @param name The name of the property * @param defval The default value to turn as a boolean if * property is not present @@ -164,7 +164,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Stores the given property and its value as a boolean. * <P> - * + * * @param name The property name * @param value The value as a boolean */ @@ -173,7 +173,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrieves the given property as an integer. * <P> - * + * * @param name The property name * @return The property value as an integer * @exception EPropertyNotFound If property is not found @@ -185,7 +185,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrieves the given property as an integer. * <P> - * + * * @param name The property name * @return int The default value to return as an integer * @exception EBaseException If the value cannot be converted to a @@ -197,7 +197,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Sets a property and its value as an integer. * <P> - * + * * @param name parameter name * @param value integer value */ @@ -206,7 +206,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrieves the given property as a big integer. * <P> - * + * * @param name The property name * @return The property value as a big integer * @exception EPropertyNotFound If property is not found @@ -218,7 +218,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrieves the given property as a big integer. * <P> - * + * * @param name The property name * @return int The default value to return as a big integer * @exception EBaseException If the value cannot be converted to a @@ -230,7 +230,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Sets a property and its value as an integer. * <P> - * + * * @param name parameter name * @param value big integer value */ @@ -239,7 +239,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Creates a nested sub-store with the specified name. * <P> - * + * * @param name The name of the sub-store * @return The sub-store created */ @@ -248,7 +248,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrieves the given sub-store. * <P> - * + * * @param name The name of the sub-store * @return The sub-store */ @@ -258,7 +258,7 @@ public interface IConfigStore extends ISourceConfigStore { * Removes sub-store with the given name. * (Removes all properties and sub-stores under this sub-store.) * <P> - * + * * @param name The name of the sub-store to remove */ public void removeSubStore(String name); @@ -267,7 +267,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Retrives and enumeration of all properties in this config-store. - * + * * @return An enumeration of all properties in this config-store */ public Enumeration<String> getPropertyNames(); @@ -276,7 +276,7 @@ public interface IConfigStore extends ISourceConfigStore { * Returns an enumeration of the names of the substores of * this config-store. * <P> - * + * * @return An enumeration of the names of the sub-stores of this * config-store */ @@ -284,7 +284,7 @@ public interface IConfigStore extends ISourceConfigStore { /** * Commits all the data into file immediately. - * + * * @param createBackup true if a backup file should be created * @exception EBaseException failed to commit */ |