(no commit message)

[utils] / crawler / basic / src / org / wamblee / crawler / impl / ConfigItem.java

diff --git a/crawler/basic/src/org/wamblee/crawler/impl/ConfigItem.java b/crawler/basic/src/org/wamblee/crawler/impl/ConfigItem.java
index 7dfd9169cf7ac650b0862b05d237ff39ad54fd7a..6349d2c1b77fbe96c43ae541725369822b2bf9f1 100644 (file)
--- a/crawler/basic/src/org/wamblee/crawler/impl/ConfigItem.java
+++ b/crawler/basic/src/org/wamblee/crawler/impl/ConfigItem.java
@@ -12,28 +12,39 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ 
+ */
 
 package org.wamblee.crawler.impl;
 
 import java.util.regex.Pattern;
 
 /**
- * 
+ * Configuration item for obtaining an object in case a pattern matches.
  */
 class ConfigItem<ValueType> {
-    
+
     private Pattern _pattern;
-    private ValueType _value; 
-    
-    protected ConfigItem(String aPattern, ValueType aValue) { 
+
+    private ValueType _value;
+
+    /**
+     * Constructs the item. 
+     * @param aPattern Pattern. 
+     * @param aValue Value. 
+     */
+    protected ConfigItem(String aPattern, ValueType aValue) {
         _pattern = Pattern.compile(aPattern);
         _value = aValue;
     }
-    
-    protected ValueType match(String aValue) { 
-        if ( !_pattern.matcher(aValue).matches() ) { 
-            return null; 
+
+    /**
+     * Returns the object in case the value matches. 
+     * @param aValue Value to match. 
+     * @return Object in case there is a match, null otherwise. 
+     */
+    protected ValueType match(String aValue) {
+        if (!_pattern.matcher(aValue).matches()) {
+            return null;
         }
         return _value;
     }