diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/property')
5 files changed, 51 insertions, 67 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/property/Descriptor.java b/pki/base/common/src/com/netscape/certsrv/property/Descriptor.java index 92aeff185..15b6e990a 100644 --- a/pki/base/common/src/com/netscape/certsrv/property/Descriptor.java +++ b/pki/base/common/src/com/netscape/certsrv/property/Descriptor.java @@ -19,10 +19,9 @@ package com.netscape.certsrv.property; import java.util.Locale; - /** - * This interface represents a property descriptor. A descriptor - * includes information that describe a property. + * This interface represents a property descriptor. A descriptor includes + * information that describe a property. * * @version $Revision$, $Date$ */ @@ -35,13 +34,14 @@ public class Descriptor implements IDescriptor { /** * Constructs a descriptor. - * + * * @param syntax syntax * @param constraint constraint * @param defValue default value * @param description description */ - public Descriptor(String syntax, String constraint, String defValue, String description) { + public Descriptor(String syntax, String constraint, String defValue, + String description) { mSyntax = syntax; mConstraint = constraint; mDef = defValue; @@ -50,16 +50,16 @@ public class Descriptor implements IDescriptor { /** * Returns the syntax of the property. - * + * * @return syntax */ public String getSyntax() { return mSyntax; } - + /** * Returns the default value of the property. - * + * * @return default value */ public String getDefaultValue() { @@ -69,14 +69,14 @@ public class Descriptor implements IDescriptor { /** * Constraint for the given syntax. For example, * <p> - * - number(1-5): 1-5 is the constraint, and it indicates - * that the number must be in the range of 1 to 5. + * - number(1-5): 1-5 is the constraint, and it indicates that the number + * must be in the range of 1 to 5. * <p> - * - choice(cert,crl): cert,crl is the constraint - * for choice + * - choice(cert,crl): cert,crl is the constraint for choice * <p> * If null, no constraint shall be enforced. * <p> + * * @return constraint */ public String getConstraint() { @@ -85,6 +85,7 @@ public class Descriptor implements IDescriptor { /** * Retrieves the description of the property. + * * @param locale user locale * @return description */ diff --git a/pki/base/common/src/com/netscape/certsrv/property/EPropertyException.java b/pki/base/common/src/com/netscape/certsrv/property/EPropertyException.java index a5847cb21..23f59a25f 100644 --- a/pki/base/common/src/com/netscape/certsrv/property/EPropertyException.java +++ b/pki/base/common/src/com/netscape/certsrv/property/EPropertyException.java @@ -17,12 +17,11 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.property; - import com.netscape.certsrv.base.EBaseException; /** * This is the base exception for property handling. - * + * * @version $Revision$, $Date$ */ public class EPropertyException extends EBaseException { @@ -34,7 +33,7 @@ public class EPropertyException extends EBaseException { /** * Constructs property exception - * + * * @param msg exception message */ public EPropertyException(String msg) { diff --git a/pki/base/common/src/com/netscape/certsrv/property/IConfigTemplate.java b/pki/base/common/src/com/netscape/certsrv/property/IConfigTemplate.java index f435db50c..32464fa8a 100644 --- a/pki/base/common/src/com/netscape/certsrv/property/IConfigTemplate.java +++ b/pki/base/common/src/com/netscape/certsrv/property/IConfigTemplate.java @@ -17,21 +17,17 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.property; - import java.util.Enumeration; import java.util.Locale; - /** - * This interface provides a standard way to describe - * a set of configuration parameters and its associated syntax. - * It provides programmatic methods for querying - * template description. + * This interface provides a standard way to describe a set of configuration + * parameters and its associated syntax. It provides programmatic methods for + * querying template description. * <p> - * A plugin, for example, can be described as a - * property template. + * A plugin, for example, can be described as a property template. * <p> - * + * * @version $Revision$, $Date$ */ public interface IConfigTemplate { @@ -45,7 +41,7 @@ public interface IConfigTemplate { /** * Returns the descriptors of configuration parameter. - * + * * @param locale user locale * @param name configuration parameter name * @return descriptor @@ -54,17 +50,16 @@ public interface IConfigTemplate { /** * Sets configuration parameter. - * + * * @param name parameter name * @param value parameter value * @exception EPropertyException failed to set parameter */ - public void setConfig(String name, String value) - throws EPropertyException; + public void setConfig(String name, String value) throws EPropertyException; /** * Retrieves configuration parameter by name. - * + * * @return parameter */ public String getConfig(String name); diff --git a/pki/base/common/src/com/netscape/certsrv/property/IDescriptor.java b/pki/base/common/src/com/netscape/certsrv/property/IDescriptor.java index 271c1808a..d70156f72 100644 --- a/pki/base/common/src/com/netscape/certsrv/property/IDescriptor.java +++ b/pki/base/common/src/com/netscape/certsrv/property/IDescriptor.java @@ -17,13 +17,11 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.property; - import java.util.Locale; - /** * This interface represents a property descriptor. - * + * * @version $Revision$, $Date$ */ public interface IDescriptor { @@ -54,26 +52,24 @@ public interface IDescriptor { /** * Returns the syntax of the property. - * + * * @return syntax */ public String getSyntax(); /** - * Constraint for the given syntax. For example, - * - number(1-5): 1-5 is the constraint, and it indicates - * that the number must be in the range of 1 to 5. - * - choice(cert,crl): cert,crl is the constraint - * for choice - * If null, no constraint shall be enforced. - * + * Constraint for the given syntax. For example, - number(1-5): 1-5 is the + * constraint, and it indicates that the number must be in the range of 1 to + * 5. - choice(cert,crl): cert,crl is the constraint for choice If null, no + * constraint shall be enforced. + * * @return constraint */ public String getConstraint(); /** * Retrieves the description of the property. - * + * * @param locale user locale * @return localized description */ @@ -81,7 +77,7 @@ public interface IDescriptor { /** * Retrieves the default value of the property. - * + * * @return default value */ public String getDefaultValue(); diff --git a/pki/base/common/src/com/netscape/certsrv/property/PropertySet.java b/pki/base/common/src/com/netscape/certsrv/property/PropertySet.java index 360477fe9..875f40281 100644 --- a/pki/base/common/src/com/netscape/certsrv/property/PropertySet.java +++ b/pki/base/common/src/com/netscape/certsrv/property/PropertySet.java @@ -20,40 +20,33 @@ package com.netscape.certsrv.property; import java.util.Enumeration; import java.util.Hashtable; - /** * A set of properties. */ public class PropertySet { - private Hashtable mProperties = new Hashtable(); + private Hashtable mProperties = new Hashtable(); - public PropertySet() - { - } + public PropertySet() { + } - public void add(String name, IDescriptor desc) - { - mProperties.put(name, desc); - } + public void add(String name, IDescriptor desc) { + mProperties.put(name, desc); + } - public Enumeration getNames() - { - return mProperties.keys(); - } + public Enumeration getNames() { + return mProperties.keys(); + } - public IDescriptor getDescriptor(String name) - { - return (IDescriptor)mProperties.get(name); - } + public IDescriptor getDescriptor(String name) { + return (IDescriptor) mProperties.get(name); + } - public void remove(String name) - { - mProperties.remove(name); - } + public void remove(String name) { + mProperties.remove(name); + } - public int size() - { - return mProperties.size(); - } + public int size() { + return mProperties.size(); + } } |