- From: Jonathan Barouh via cvs-syncmail <cvsmail@w3.org>
- Date: Tue, 17 Jun 2008 13:45:33 +0000
- To: www-validator-cvs@w3.org
Update of /sources/public/2006/unicorn/org/w3c/unicorn/tasklist/parameters
In directory hutz:/tmp/cvs-serv14031/org/w3c/unicorn/tasklist/parameters
Modified Files:
Mapping.java CheckboxParameter.java DropDownParameter.java
TextFieldParameter.java CheckboxListParameter.java
RadioParameter.java TextAreaParameter.java Value.java
Log Message:
Updating Javadoc for the project.
Index: DropDownParameter.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/tasklist/parameters/DropDownParameter.java,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- DropDownParameter.java 31 Aug 2006 09:09:27 -0000 1.1.1.1
+++ DropDownParameter.java 17 Jun 2008 13:45:31 -0000 1.2
@@ -19,15 +19,28 @@
private Map<String, Value> mapOfValue;
private Value aValueDefault;
+ /**
+ * Default constructor for a DropDownParameter
+ * (see the Parameter default constructor).
+ */
protected DropDownParameter () {
super();
DropDownParameter.logger.trace("Constructor()");
}
+ /**
+ * Adds a Value object to the mapOfValue.
+ * @param aValue The value to add.
+ */
public void addValue (final Value aValue) {
this.mapOfValue.put(aValue.getName(), aValue);
}
+ /**
+ * Finds a Value object in the map given its name.
+ * @param sName The name of the Value.
+ * @return The Value object if the String corresponds to a key.
+ */
public Value getValue (final String sName) {
return this.mapOfValue.get(sName);
}
@@ -42,6 +55,10 @@
return mapOfValue;
}
+ /**
+ * Sets the default Value in the mapOfDefaultValue.
+ * @param sDefaultValues The new default value.
+ */
public void setDefaultValues (final String sDefaultValues) {
this.aValueDefault = this.mapOfValue.get(sDefaultValues);
}
@@ -54,6 +71,10 @@
return this.mapOfValue;
}
+ /**
+ * Defines or replaces the mapOfValue.
+ * @param mapOfValue The new map of values.
+ */
public void setMapOfValue (final Map<String, Value> mapOfValue) throws ParameterException {
if (mapOfValue.size() < 1) {
DropDownParameter.logger.error("Dropdown parameter must have at least one value.");
@@ -62,10 +83,19 @@
this.mapOfValue = mapOfValue;
}
+ /**
+ * Returns the type of the parameter.
+ * @return The type DROPDOWN.
+ */
public ParameterType getType () {
return ParameterType.DROPDOWN;
}
+ /**
+ * Merges a Parameter with this one if the type complies.
+ * @param aParameter The parameter to merge with the current one.
+ * @return True if they merged correctly, else false.
+ */
public boolean merge (final Parameter aParameter) {
DropDownParameter.logger.trace("merge");
// Types must match
Index: CheckboxListParameter.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/tasklist/parameters/CheckboxListParameter.java,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- CheckboxListParameter.java 31 Aug 2006 09:09:27 -0000 1.1.1.1
+++ CheckboxListParameter.java 17 Jun 2008 13:45:31 -0000 1.2
@@ -17,15 +17,28 @@
private Map<String, Value> mapOfValue;
private Map<String, Value> mapOfDefaultValue;
+ /**
+ * Default constructor for a CheckboxListParameter
+ * (see Parameter default constructor).
+ */
protected CheckboxListParameter () {
super();
CheckboxListParameter.logger.trace("Constructor()");
}
+ /**
+ * Adds a Value object to the mapOfValue.
+ * @param aValue The value to add.
+ */
public void addValue (final Value aValue) {
this.mapOfValue.put(aValue.getName(), aValue);
}
+ /**
+ * Finds a Value object in the map given its name.
+ * @param sName The name of the Value.
+ * @return The Value object if the String corresponds to a key.
+ */
public Value getValue (final String sName) {
return this.mapOfValue.get(sName);
}
@@ -38,6 +51,10 @@
return this.mapOfDefaultValue;
}
+ /**
+ * Sets the default Value in the mapOfDefaultValue.
+ * @param sDefaultValues The new default value.
+ */
public void setDefaultValues (final String sDefaultValues) {
this.mapOfDefaultValue = new LinkedHashMap<String, Value>();
for (String sDefault : sDefaultValues.split(",")) {
@@ -62,14 +79,27 @@
return this.mapOfValue;
}
+ /**
+ * Defines or replaces the mapOfValue.
+ * @param mapOfValue The new map of values.
+ */
public void setMapOfValue (final Map<String, Value> mapOfValue) {
this.mapOfValue = mapOfValue;
}
+ /**
+ * Returns the type of the parameter.
+ * @return The type CHECKBOXLIST.
+ */
public ParameterType getType () {
return ParameterType.CHECKBOXLIST;
}
+ /**
+ * Merges a Parameter with this one if the type complies.
+ * @param aParameter The parameter to merge with the current one.
+ * @return True if they merged correctly, else false.
+ */
public boolean merge (final Parameter aParameter) {
CheckboxListParameter.logger.trace("merge");
// Types must match
Index: TextFieldParameter.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/tasklist/parameters/TextFieldParameter.java,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- TextFieldParameter.java 31 Aug 2006 09:09:27 -0000 1.1.1.1
+++ TextFieldParameter.java 17 Jun 2008 13:45:31 -0000 1.2
@@ -18,15 +18,28 @@
private Value aValueDefault;
+ /**
+ * Default constructor for a TextFieldParameter
+ * (see the Parameter default constructor).
+ */
protected TextFieldParameter () {
super();
TextFieldParameter.logger.trace("Constructor()");
}
+ /**
+ * Adds a Value object to the mapOfValue.
+ * @param aValue The value to add.
+ */
public void addValue (final Value aValue) {
this.aValueDefault = aValue;
}
+ /**
+ * Finds a Value object in the map given its name.
+ * @param sName The name of the Value.
+ * @return The Value object if the String corresponds to a key.
+ */
public Value getValue (final String sName) {
if (this.aValueDefault.getName().equals(sName)) {
return this.aValueDefault;
@@ -44,6 +57,10 @@
return mapOfValue;
}
+ /**
+ * Sets the default Value in the mapOfDefaultValue.
+ * @param sDefaultValues The new default value.
+ */
public void setDefaultValues (final String sDefaultValues) {
this.aValueDefault.setName(sDefaultValues);
}
@@ -56,7 +73,11 @@
// no value because we allow any text
return null;
}
-
+
+ /**
+ * Defines or replaces the mapOfValue.
+ * @param mapOfValue The new map of values.
+ */
public void setMapOfValue (final Map<String, Value> mapOfValue) throws ParameterException {
if (mapOfValue.size() != 1) {
TextFieldParameter.logger.error("TextField parameter should have exactly one value.");
@@ -64,11 +85,19 @@
}
this.aValueDefault = mapOfValue.values().iterator().next();
}
-
+ /**
+ * Returns the type of the parameter.
+ * @return The type TEXTFIELD.
+ */
public ParameterType getType () {
return ParameterType.TEXTFIELD;
}
-
+
+ /**
+ * Merges a Parameter with this one if the type complies.
+ * @param aParameter The parameter to merge with the current one.
+ * @return True if they merged correctly, else false.
+ */
public boolean merge (final Parameter aParameter) {
TextFieldParameter.logger.trace("merge");
// Types must match
Index: RadioParameter.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/tasklist/parameters/RadioParameter.java,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- RadioParameter.java 31 Aug 2006 09:09:27 -0000 1.1.1.1
+++ RadioParameter.java 17 Jun 2008 13:45:31 -0000 1.2
@@ -18,15 +18,28 @@
private Map<String, Value> mapOfValue;
private Value aValueDefault;
+ /**
+ * Default constructor for a RadioParameter
+ * (see the Parameter default constructor).
+ */
protected RadioParameter () {
super();
RadioParameter.logger.trace("Constructor()");
}
+ /**
+ * Adds a Value object to the mapOfValue.
+ * @param aValue The value to add.
+ */
public void addValue (final Value aValue) {
this.mapOfValue.put(aValue.getName(), aValue);
}
+ /**
+ * Finds a Value object in the map given its name.
+ * @param sName The name of the Value.
+ * @return The Value object if the String corresponds to a key.
+ */
public Value getValue (final String sName) {
return this.mapOfValue.get(sName);
}
@@ -41,6 +54,10 @@
return mapOfValue;
}
+ /**
+ * Sets the default Value in the mapOfDefaultValue.
+ * @param sDefaultValues The new default value.
+ */
public void setDefaultValues (final String sDefaultValues) {
this.aValueDefault = this.mapOfValue.get(sDefaultValues);
}
@@ -53,6 +70,10 @@
return this.mapOfValue;
}
+ /**
+ * Defines or replaces the mapOfValue.
+ * @param mapOfValue The new map of values.
+ */
public void setMapOfValue (final Map<String, Value> mapOfValue) throws ParameterException {
if (mapOfValue.size() == 0) {
throw new ParameterException("Radio parameter must have at least one value.");
@@ -60,10 +81,19 @@
this.mapOfValue = mapOfValue;
}
+ /**
+ * Returns the type of the parameter.
+ * @return The type RADIO.
+ */
public ParameterType getType () {
return ParameterType.RADIO;
}
-
+
+ /**
+ * Merges a Parameter with this one if the type complies.
+ * @param aParameter The parameter to merge with the current one.
+ * @return True if they merged correctly, else false.
+ */
public boolean merge (final Parameter aParameter) {
RadioParameter.logger.trace("merge");
// Types must match
Index: CheckboxParameter.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/tasklist/parameters/CheckboxParameter.java,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- CheckboxParameter.java 31 Aug 2006 09:09:27 -0000 1.1.1.1
+++ CheckboxParameter.java 17 Jun 2008 13:45:31 -0000 1.2
@@ -18,15 +18,28 @@
private boolean bCheckedByDefault;
private Map<String, Value> mapOfValue = null;
+ /**
+ * Default constructor for a CheckboxParameter
+ * (see the Parameter default constructor).
+ */
protected CheckboxParameter () {
super();
CheckboxParameter.logger.trace("Constructor()");
}
+ /**
+ * Adds a Value object to the mapOfValue.
+ * @param aValue The value to add.
+ */
public void addValue (final Value aValue) {
this.mapOfValue.put(aValue.getName(), aValue);
}
+ /**
+ * Finds a Value object in the map given its name.
+ * @param sName The name of the Value.
+ * @return The Value object if the String corresponds to a key.
+ */
public Value getValue (final String sName) {
return this.mapOfValue.get(sName);
}
@@ -42,6 +55,10 @@
return mapOfValue;
}
+ /**
+ * Sets the default Value in the mapOfDefaultValue.
+ * @param sDefaultValues The new default value.
+ */
public void setDefaultValues (final String sDefaultValues) {
this.bCheckedByDefault = (
sDefaultValues != null &&
@@ -55,6 +72,10 @@
return this.mapOfValue;
}
+ /**
+ * Defines or replaces the mapOfValue.
+ * @param mapOfValue The new map of values.
+ */
public void setMapOfValue (final Map<String, Value> mapOfValue) throws ParameterException {
if (mapOfValue.size() > 2 || mapOfValue.size() < 1) {
CheckboxParameter.logger.error(
@@ -67,20 +88,24 @@
this.mapOfValue = mapOfValue;
}
/**
- * @return Returns the checked.
+ * Gets the checked Value in the mapOfValue.
+ * @return Returns the checked Value.
*/
public Value getChecked () {
return this.mapOfValue.get("checked");
}
/**
- * @param aValueChecked The checked to set.
+ * Sets the given Value to "checked" or adds it
+ * with this key.
+ * @param aValueChecked The Value to set as checked.
*/
public void setChecked (final Value aValueChecked) {
this.mapOfValue.put("checked", aValueChecked);
}
/**
+ * Gets the unchecked Value in the mapOfValue.
* @return Returns the unchecked.
*/
public Value getUnchecked () {
@@ -88,16 +113,27 @@
}
/**
- * @param aValueUnchecked The unchecked to set.
+ * Sets the given Value to "unchecked" or adds it
+ * with this key.
+ * @param aValueUnchecked The Value to set as unchecked.
*/
public void setUnchecked (final Value aValueUnchecked) {
this.mapOfValue.put("unchecked", aValueUnchecked);
}
+ /**
+ * Returns the type of the parameter.
+ * @return The type CHECKBOX.
+ */
public ParameterType getType () {
return ParameterType.CHECKBOX;
}
+ /**
+ * Merges a Parameter with this one if the type complies.
+ * @param aParameter The parameter to merge with the current one.
+ * @return True if they merged correctly, else false.
+ */
public boolean merge (final Parameter aParameter) {
CheckboxParameter.logger.trace("merge");
// Types must match
Index: Value.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/tasklist/parameters/Value.java,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- Value.java 31 Aug 2006 09:09:28 -0000 1.1.1.1
+++ Value.java 17 Jun 2008 13:45:31 -0000 1.2
@@ -91,14 +91,29 @@
this.longNames = longNames;
}
+ /**
+ * Adds a list of mapping to the mapOfListOfMapping.
+ * @param sKey The key for the list.
+ * @param listOfMapping The list to add.
+ */
public void addListOfMapping (final String sKey, final List<Mapping> listOfMapping) {
this.mapOfListOfMapping.put(sKey, listOfMapping);
}
+ /**
+ * Checks if the given mapping exists.
+ * @param sMapping
+ * @return True if the map contains sMapping, else false.
+ */
public boolean hasMapping (final String sMapping) {
return null != this.mapOfListOfMapping.get(sMapping);
}
+ /**
+ * Finds a list of mapping given its name.
+ * @param sName The name of the mapping.
+ * @return The list of mapping if the name matches an entry.
+ */
public List<Mapping> getListOfMapping (final String sName) {
return this.mapOfListOfMapping.get(sName);
}
Index: Mapping.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/tasklist/parameters/Mapping.java,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- Mapping.java 31 Aug 2006 09:09:27 -0000 1.1.1.1
+++ Mapping.java 17 Jun 2008 13:45:31 -0000 1.2
@@ -138,7 +138,6 @@
aStringBuffer.append(this.aObserver.getID());
aStringBuffer.append('.');
- //aStringBuffer.append(this.listOfEnumInputMethod);
aStringBuffer.append('.');
aStringBuffer.append(this.sParam);
aStringBuffer.append('=');
Index: TextAreaParameter.java
===================================================================
RCS file: /sources/public/2006/unicorn/org/w3c/unicorn/tasklist/parameters/TextAreaParameter.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- TextAreaParameter.java 4 Sep 2006 09:45:55 -0000 1.2
+++ TextAreaParameter.java 17 Jun 2008 13:45:31 -0000 1.3
@@ -17,23 +17,36 @@
private Value aValueDefault;
+ /**
+ * Default constructor for a TextAreaParameter
+ * (see the Parameter default constructor).
+ */
protected TextAreaParameter () {
super();
TextAreaParameter.logger.trace("Constructor()");
}
+ /**
+ * Adds a Value object to the mapOfValue.
+ * @param aValue The value to add.
+ */
public void addValue (final Value aValue) {
this.aValueDefault = aValue;
}
/**
* For velocity engine.
- * @return
+ * @return The default value.
*/
public Value getDefaultValue () {
return this.aValueDefault;
}
+ /**
+ * Finds a Value object in the map given its name.
+ * @param sName The name of the Value.
+ * @return The Value object if the String corresponds to a key.
+ */
public Value getValue (final String sName) {
if (this.aValueDefault.getName().equals(sName)) {
return this.aValueDefault;
@@ -51,6 +64,10 @@
return mapOfValue;
}
+ /**
+ * Sets the default Value in the mapOfDefaultValue.
+ * @param sDefaultValues The new default value.
+ */
public void setDefaultValues (final String sDefaultValues) {
this.aValueDefault.setName(sDefaultValues);
}
@@ -64,6 +81,10 @@
return null;
}
+ /**
+ * Defines or replaces the mapOfValue.
+ * @param mapOfValue The new map of values.
+ */
public void setMapOfValue (final Map<String, Value> mapOfValue) throws ParameterException {
if (mapOfValue.size() != 1) {
throw new ParameterException("Textarea parameter should have exactly one value.");
@@ -71,10 +92,19 @@
this.aValueDefault = mapOfValue.values().iterator().next();
}
+ /**
+ * Returns the type of the parameter.
+ * @return The type TEXTAREA.
+ */
public ParameterType getType () {
return ParameterType.TEXTAREA;
}
-
+
+ /**
+ * Merges a Parameter with this one if the type complies.
+ * @param aParameter The parameter to merge with the current one.
+ * @return True if they merged correctly, else false.
+ */
public boolean merge (final Parameter aParameter) {
TextAreaParameter.logger.trace("merge");
// Types must match
Received on Tuesday, 17 June 2008 13:46:08 UTC