[HtmlUnit] SF.net SVN: htmlunit:[3234] trunk/htmlunit/src/main/java/com/ gargoylesoftware/htmlunit/javascript/host/HTMLCollection.java

[<sd...@us...>]

Revision: 3234
          http://htmlunit.svn.sourceforge.net/htmlunit/?rev=3234&view=rev
Author:   sdanig
Date:     2008-07-31 17:09:53 +0000 (Thu, 31 Jul 2008)

Log Message:
-----------
Miscellaneous cleanup, mainly javadoc commenting.

Modified Paths:
--------------
    trunk/htmlunit/src/main/java/com/gargoylesoftware/htmlunit/javascript/host/HTMLCollection.java

Modified: trunk/htmlunit/src/main/java/com/gargoylesoftware/htmlunit/javascript/host/HTMLCollection.java
===================================================================
--- trunk/htmlunit/src/main/java/com/gargoylesoftware/htmlunit/javascript/host/HTMLCollection.java	2008-07-31 16:59:57 UTC (rev 3233)
+++ trunk/htmlunit/src/main/java/com/gargoylesoftware/htmlunit/javascript/host/HTMLCollection.java	2008-07-31 17:09:53 UTC (rev 3234)
@@ -22,7 +22,6 @@
 import org.apache.commons.collections.functors.NOPTransformer;
 import org.mozilla.javascript.Context;
 import org.mozilla.javascript.Function;
-import org.mozilla.javascript.JavaScriptException;
 import org.mozilla.javascript.Scriptable;
 import org.mozilla.javascript.ScriptableObject;
 import org.w3c.dom.Node;
@@ -105,8 +104,7 @@
     }
 
     /**
-     * Only needed to make collections like document.all available but "invisible" when
-     * simulating Firefox.
+     * Only needed to make collections like <tt>document.all</tt> available but "invisible" when simulating Firefox.
      * {@inheritDoc}
      */
     @Override
@@ -174,10 +172,7 @@
     /**
      * {@inheritDoc}
      */
-    public final Object call(
-            final Context context, final Scriptable scope,
-            final Scriptable thisObj, final Object[] args) throws JavaScriptException {
-
+    public final Object call(final Context cx, final Scriptable scope, final Scriptable thisObj, final Object[] args) {
         if (args.length == 0) {
             throw Context.reportRuntimeError("Zero arguments; need an index or a key.");
         }
@@ -187,9 +182,7 @@
     /**
      * {@inheritDoc}
      */
-    public final Scriptable construct(
-            final Context arg0, final Scriptable arg1, final Object[] arg2)
-        throws JavaScriptException {
+    public final Scriptable construct(final Context cx, final Scriptable scope, final Object[] args) {
         return null;
     }
 
@@ -210,8 +203,7 @@
     }
 
     /**
-     * Returns the element at the specified index, or <tt>NOT_FOUND</tt> if the
-     * index is invalid.
+     * Returns the element at the specified index, or <tt>NOT_FOUND</tt> if the index is invalid.
      * {@inheritDoc}
      */
     @Override
@@ -237,8 +229,8 @@
     }
 
     /**
-     * Compute the elements which associated host objects are available through this collection.
-     * @return the elements
+     * Returns the elements whose associated host objects are available through this collection.
+     * @return the elements whose associated host objects are available through this collection
      */
     protected List<Object> computeElements() {
         final List<Object> response;
@@ -393,7 +385,7 @@
     }
 
     /**
-     * Retrieves the item or items corresponding to the specified index or key.
+     * Returns the item or items corresponding to the specified index or key.
      * @param index the index or key corresponding to the element or elements to return
      * @return the element or elements corresponding to the specified index or key
      * @see <a href="http://msdn.microsoft.com/workshop/author/dhtml/reference/methods/item.asp">MSDN doc</a>
@@ -402,6 +394,13 @@
         return nullIfNotFound(get(index));
     }
 
+    /**
+     * Returns the specified object, unless it is the <tt>NOT_FOUND</tt> constant, in which case <tt>null</tt>
+     * is returned.
+     * @param object the object to return
+     * @return the specified object, unless it is the <tt>NOT_FOUND</tt> constant, in which case <tt>null</tt>
+     *         is returned
+     */
     private Object nullIfNotFound(final Object object) {
         if (object == NOT_FOUND) {
             return null;
@@ -435,7 +434,6 @@
     }
 
     /**
-     * Just for debug purpose.
      * {@inheritDoc}
      */
     @Override
@@ -477,13 +475,12 @@
             final int index = Integer.parseInt(name);
             final List<Object> elements = getElements();
             CollectionUtils.transform(elements, transformer_);
-
             if (index >= 0 && index < elements.size()) {
                 return true;
             }
         }
-        catch (final Exception e) {
-            //ignore
+        catch (final NumberFormatException e) {
+            // Ignore.
         }
 
         if (name.equals("length")) {
@@ -567,8 +564,6 @@
     private class DomHtmlAttributeChangeListenerImpl implements DomChangeListener, HtmlAttributeChangeListener,
         NonSerializable {
 
-        private static final long serialVersionUID = 5296270270141251350L;
-
         /**
          * {@inheritDoc}
          */


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.