code cleanup

rbri · rbri · commit a4c7ea7d2ba5 · 2025-10-01T14:25:41.000+02:00
diff --git a/src/main/java/org/htmlunit/FormEncodingType.java b/src/main/java/org/htmlunit/FormEncodingType.java
@@ -30,7 +30,7 @@ public final class FormEncodingType implements Serializable {
     /** URL-encoded form encoding. */
     public static final FormEncodingType URL_ENCODED = new FormEncodingType("application/x-www-form-urlencoded");
 
-    /** Multipart form encoding (used to be a constant in HttpClient but it was deprecated with no alternative). */
+    /** Multipart form encoding (used to be a constant in HttpClient, but it was deprecated with no alternative). */
     public static final FormEncodingType MULTIPART = new FormEncodingType("multipart/form-data");
 
     /** text/plain. */
diff --git a/src/main/java/org/htmlunit/attachment/DownloadingAttachmentHandler.java b/src/main/java/org/htmlunit/attachment/DownloadingAttachmentHandler.java
@@ -34,7 +34,7 @@
  * <li>download file into a default folder when attachment response is detected</li>
  * <li>infer filename from octet stream response and use that when saving file</li>
  * <li>if a file already exists, append number to it.
- * Keep incrementing numbers until you find a slot that is free (thats how Chrome handles duplicate filenames).</li>
+ * Keep incrementing numbers until you find a slot that is free (that's how Chrome handles duplicate filenames).</li>
  * </ul>
  *
  * @author Marek Andreansky
diff --git a/src/main/java/org/htmlunit/html/DomText.java b/src/main/java/org/htmlunit/html/DomText.java
@@ -184,7 +184,7 @@ private void initDoTypeProcessor() {
     }
 
     /**
-     * Indicates if the provided character can by "typed" in the element.
+     * Indicates if the provided character can be "typed" in the element.
      * @param c the character
      * @return {@code true} if it is accepted
      */
diff --git a/src/main/java/org/htmlunit/html/HtmlDivision.java b/src/main/java/org/htmlunit/html/HtmlDivision.java
@@ -35,7 +35,7 @@ public class HtmlDivision extends HtmlElement {
     /**
      * Creates an instance of HtmlDivision.
      *
-     * <p><b>Don't directly construct, it is public as an implementation side-effect.</b>
+     * <p><b>Don't directly construct, it is public as an implementation side effect.</b>
      *
      * @param qualifiedName the qualified name of the element type to instantiate
      * @param page the HtmlPage that contains this element
diff --git a/src/main/java/org/htmlunit/html/HtmlElement.java b/src/main/java/org/htmlunit/html/HtmlElement.java
@@ -209,7 +209,7 @@ protected void setAttributeNS(final String namespaceURI, final String qualifiedN
         final boolean mappedElement = isAttachedToPage()
                 && (DomElement.NAME_ATTRIBUTE.equals(qualifiedName) || DomElement.ID_ATTRIBUTE.equals(qualifiedName));
         if (mappedElement) {
-            // cast is save here because isMappedElement checks for HtmlPage
+            // cast is safe here because isMappedElement checks for HtmlPage
             htmlPage.removeMappedElement(this, false, false);
         }
 
@@ -363,7 +363,7 @@ public void removeAttribute(final String attributeName) {
 
     /**
      * Support for reporting HTML attribute changes. This method can be called when an attribute
-     * has been added and it will send the appropriate {@link HtmlAttributeChangeEvent} to any
+     * has been added, and it will send the appropriate {@link HtmlAttributeChangeEvent} to any
      * registered {@link HtmlAttributeChangeListener}s.
      * <p>
      * Note that this method recursively calls this element's parent's
@@ -381,7 +381,7 @@ protected void fireHtmlAttributeAdded(final HtmlAttributeChangeEvent event) {
 
     /**
      * Support for reporting HTML attribute changes. This method can be called when an attribute
-     * has been replaced and it will send the appropriate {@link HtmlAttributeChangeEvent} to any
+     * has been replaced, and it will send the appropriate {@link HtmlAttributeChangeEvent} to any
      * registered {@link HtmlAttributeChangeListener}s.
      * <p>
      * Note that this method recursively calls this element's parent's
@@ -399,7 +399,7 @@ protected void fireHtmlAttributeReplaced(final HtmlAttributeChangeEvent event) {
 
     /**
      * Support for reporting HTML attribute changes. This method can be called when an attribute
-     * has been removed and it will send the appropriate {@link HtmlAttributeChangeEvent} to any
+     * has been removed, and it will send the appropriate {@link HtmlAttributeChangeEvent} to any
      * registered {@link HtmlAttributeChangeListener}s.
      * <p>
      * Note that this method recursively calls this element's parent's
@@ -864,7 +864,7 @@ protected void typeDone(final String newValue, final boolean notifyAttributeChan
     }
 
     /**
-     * Indicates if the provided character can by "typed" in the element.
+     * Indicates if the provided character can be "typed" in the element.
      * @param c the character
      * @return {@code true} if it is accepted
      */
diff --git a/src/main/java/org/htmlunit/html/HtmlFileInput.java b/src/main/java/org/htmlunit/html/HtmlFileInput.java
@@ -68,7 +68,7 @@ public class HtmlFileInput extends HtmlInput implements LabelableElement {
 
     /**
      * Returns the in-memory data assigned to this file input element, if any.
-     * @return {@code null} if {@link #setData(byte[])} hasn't be used
+     * @return {@code null} if {@link #setData(byte[])} hasn't been used
      */
     public final byte[] getData() {
         return data_;
diff --git a/src/main/java/org/htmlunit/html/HtmlForm.java b/src/main/java/org/htmlunit/html/HtmlForm.java
@@ -417,10 +417,10 @@ public List<NameValuePair> getParameterListForSubmit(final SubmittableElement su
      * @return the page contained by this form's window after the reset
      */
     public Page reset() {
-        final SgmlPage htmlPage = getPage();
+        final SgmlPage sgmlPage = getPage();
         final ScriptResult scriptResult = fireEvent(Event.TYPE_RESET);
         if (ScriptResult.isFalse(scriptResult)) {
-            return htmlPage.getWebClient().getCurrentWindow().getEnclosedPage();
+            return sgmlPage.getWebClient().getCurrentWindow().getEnclosedPage();
         }
 
         for (final HtmlElement next : getHtmlElementDescendants()) {
@@ -429,7 +429,7 @@ public Page reset() {
             }
         }
 
-        return htmlPage;
+        return sgmlPage;
     }
 
     /**
@@ -490,7 +490,7 @@ private static boolean isValidForSubmission(final HtmlElement element, final Sub
                 return ((HtmlInput) element).isChecked();
             }
         }
-        if (HtmlSelect.TAG_NAME.equals(tagName)) {
+        if (element instanceof HtmlSelect) {
             return ((HtmlSelect) element).isValidForSubmission();
         }
         return true;
diff --git a/src/main/java/org/htmlunit/javascript/host/Element.java b/src/main/java/org/htmlunit/javascript/host/Element.java
@@ -175,7 +175,7 @@ public NamedNodeMap getAttributes() {
     }
 
     /**
-     * Creates the JS object for the property attributes. This object will the be cached.
+     * Creates the JS object for the property attributes. This object will be cached.
      * @return the JS object
      */
     protected NamedNodeMap createAttributesObject() {
@@ -636,7 +636,7 @@ public HTMLCollection getElementsByClassName(final String className) {
                     }
                     String classAttribute = ((HtmlElement) node).getAttributeDirect("class");
                     if (ATTRIBUTE_NOT_DEFINED == classAttribute) {
-                        return false; // probably better performance as most of elements won't have a class attribute
+                        return false; // probably better performance as most elements won't have a class attribute
                     }
 
                     classAttribute = " " + classAttribute + " ";
@@ -760,7 +760,7 @@ private Object[] getInsertAdjacentLocation(final String where) {
         // compute the where and how the new nodes should be added
         if (POSITION_AFTER_BEGIN.equalsIgnoreCase(where)) {
             if (currentNode.getFirstChild() == null) {
-                // new nodes should appended to the children of current node
+                // new nodes should append to the children of current node
                 node = currentNode;
                 append = true;
             }
@@ -776,13 +776,13 @@ else if (POSITION_BEFORE_BEGIN.equalsIgnoreCase(where)) {
             append = false;
         }
         else if (POSITION_BEFORE_END.equalsIgnoreCase(where)) {
-            // new nodes should appended to the children of current node
+            // new nodes should append to the children of current node
             node = currentNode;
             append = true;
         }
         else if (POSITION_AFTER_END.equalsIgnoreCase(where)) {
             if (currentNode.getNextSibling() == null) {
-                // new nodes should appended to the children of parent node
+                // new nodes should append to the children of parent node
                 node = currentNode.getParentNode();
                 append = true;
             }
diff --git a/src/main/java/org/htmlunit/javascript/host/event/Event.java b/src/main/java/org/htmlunit/javascript/host/event/Event.java
@@ -933,7 +933,7 @@ public String getPropertyName() {
      * Initializes this event.
      * @param type the event type
      * @param bubbles whether or not the event should bubble
-     * @param cancelable whether or not the event the event should be cancelable
+     * @param cancelable whether or not the event should be cancelable
      */
     @JsxFunction
     public void initEvent(final String type, final boolean bubbles, final boolean cancelable) {
diff --git a/src/main/java/org/htmlunit/javascript/host/event/EventHandler.java b/src/main/java/org/htmlunit/javascript/host/event/EventHandler.java
@@ -58,7 +58,7 @@ public Object call(final Context cx, final Scriptable scope,
         // final HtmlUnitScriptable jsObj = node_.getScriptableObject();
         // have changed this - the scope is now thisObj to fix
         // https://github.com/HtmlUnit/htmlunit/issues/347
-        // but i still have not found any description about the right scope
+        // but still have not found any description about the right scope
 
         // compile "just in time"
         if (realFunction_ == null) {
diff --git a/src/main/java/org/htmlunit/javascript/host/event/EventListenersContainer.java b/src/main/java/org/htmlunit/javascript/host/event/EventListenersContainer.java
@@ -50,8 +50,8 @@ public class EventListenersContainer implements Serializable {
 
     private static final Log LOG = LogFactory.getLog(EventListenersContainer.class);
 
-    // Refactoring note: This seems ad-hoc..  Shouldn't synchronization be orchestrated between
-    // JS thread and main thread at a much higher layer?  Anyways, to preserve behaviour of prior
+    // Refactoring note: This seems ad-hoc. Shouldn't synchronization be orchestrated between
+    // JS thread and main thread at a much higher layer?  Anyway, to preserve behaviour of prior
     // coding where 'synchronized' was used more explicitly, we're using a ConcurrentHashMap here
     // and using ConcurrentMap.compute() to mutate below so that mutations are atomic.  This for
     // example avoids the case where two concurrent addListener()s can result in either being lost.
diff --git a/src/main/java/org/htmlunit/javascript/host/event/EventTarget.java b/src/main/java/org/htmlunit/javascript/host/event/EventTarget.java
@@ -135,11 +135,11 @@ public ScriptResult fireEvent(final Event event) {
             }
 
             // The load event has some unnatural behavior that we need to handle specially
-            // The load event for other elements target that element and but path only
+            // The load event for other elements target that element but path only
             // up to Document and not Window, so do nothing here
             // (see Note in https://www.w3.org/TR/DOM-Level-3-Events/#event-type-load)
             if (!Event.TYPE_LOAD.equals(event.getType())) {
-                // Add Window if the the propagation path reached Document
+                // Add Window if the propagation path reached Document
                 if (propagationPath.get(propagationPath.size() - 1) instanceof Document) {
                     propagationPath.add(window);
                 }
diff --git a/src/main/java/org/htmlunit/javascript/host/html/HTMLDocument.java b/src/main/java/org/htmlunit/javascript/host/html/HTMLDocument.java
@@ -179,7 +179,7 @@ public static void writeln(final Context context, final Scriptable scope,
 
     /**
      * Returns the current document instance, using <code>thisObj</code> as a hint.
-     * @param thisObj a hint as to the current document (may be the prototype when function is used without "this")
+     * @param thisObj a hint as to the current document (maybe the prototype when function is used without "this")
      * @return the current document instance
      */
     private static HTMLDocument getDocument(final Scriptable thisObj) {
@@ -199,7 +199,7 @@ private static HTMLDocument getDocument(final Scriptable thisObj) {
 
     /**
      * This a hack!!! A cleaner way is welcome.
-     * Handle a case where document.write is simply ignored.
+     * Handle a case where document.write() is simply ignored.
      * See HTMLDocumentWrite2Test.write_fromScriptAddedWithAppendChild_external.
      * @param executing indicates if executing or not
      */
@@ -602,7 +602,7 @@ private Object getIt(final String name) {
 
         final boolean alsoFrames = getBrowserVersion().hasFeature(HTMLDOCUMENT_GET_ALSO_FRAMES);
 
-        // for performance
+        // for performance,
         // we will calculate the elements to decide if we really have
         // to really create a HTMLCollection or not
         final List<DomNode> matchingElements = getItComputeElements(page, name, alsoFrames);
diff --git a/src/main/java/org/htmlunit/platform/font/AwtFontUtil.java b/src/main/java/org/htmlunit/platform/font/AwtFontUtil.java
@@ -45,12 +45,10 @@ public int countLines(final String content, final int pixelWidth, final String f
                 attributedString.addAttribute(TextAttribute.SIZE, fontSizeInt / 1.1);
                 final LineBreakMeasurer lineBreakMeasurer =
                         new LineBreakMeasurer(attributedString.getIterator(), fontRenderCtx);
-                lineBreakMeasurer.nextLayout(pixelWidth);
-                lineCount++;
-                while (lineBreakMeasurer.getPosition() < line.length() && lineCount < 1000) {
+                do {
                     lineBreakMeasurer.nextLayout(pixelWidth);
                     lineCount++;
-                }
+                } while (lineBreakMeasurer.getPosition() < line.length() && lineCount < 1000);
             }
         }
         return lineCount;
diff --git a/src/main/java/org/htmlunit/util/EncodingSniffer.java b/src/main/java/org/htmlunit/util/EncodingSniffer.java
@@ -410,16 +410,12 @@ public static Charset extractEncodingFromContentType(final String s) {
         if (bytes[i] != '=') {
             return null;
         }
-        i++;
-        if (i == bytes.length) {
-            return null;
-        }
-        while (bytes[i] == 0x09 || bytes[i] == 0x0A || bytes[i] == 0x0C || bytes[i] == 0x0D || bytes[i] == 0x20) {
+        do {
             i++;
             if (i == bytes.length) {
                 return null;
             }
-        }
+        } while (bytes[i] == 0x09 || bytes[i] == 0x0A || bytes[i] == 0x0C || bytes[i] == 0x0D || bytes[i] == 0x20);
         if (bytes[i] == '"') {
             if (bytes.length <= i + 1) {
                 return null;
@@ -580,7 +576,7 @@ static boolean matches(final byte[] bytes, final int i, final byte[][] sought) {
     }
 
     /**
-     * Skips ahead to the first occurrence of any of the specified targets within the specified array,
+     * Skips ahead to the first occurrence of the specified targets within the specified array,
      * starting at the specified index. This method returns <code>-1</code> if none of the targets are found.
      *
      * @param bytes the array to search through

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@`
`34`	`34`	`* <li>download file into a default folder when attachment response is detected</li>`
`35`	`35`	`* <li>infer filename from octet stream response and use that when saving file</li>`
`36`	`36`	`* <li>if a file already exists, append number to it.`
`37`		`- * Keep incrementing numbers until you find a slot that is free (thats how Chrome handles duplicate filenames).</li>`
	`37`	`+ * Keep incrementing numbers until you find a slot that is free (that's how Chrome handles duplicate filenames).</li>`
`38`	`38`	`* </ul>`
`39`	`39`	`*`
`40`	`40`	`* @author Marek Andreansky`
Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,7 @@ private void initDoTypeProcessor() {`
`184`	`184`	`}`
`185`	`185`
`186`	`186`	`/**`
`187`		`- * Indicates if the provided character can by "typed" in the element.`
	`187`	`+ * Indicates if the provided character can be "typed" in the element.`
`188`	`188`	`* @param c the character`
`189`	`189`	`* @return {@code true} if it is accepted`
`190`	`190`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public class HtmlDivision extends HtmlElement {`
`35`	`35`	`/**`
`36`	`36`	`* Creates an instance of HtmlDivision.`
`37`	`37`	`*`
`38`		`- * <p><b>Don't directly construct, it is public as an implementation side-effect.</b>`
	`38`	`+ * <p><b>Don't directly construct, it is public as an implementation side effect.</b>`
`39`	`39`	`*`
`40`	`40`	`* @param qualifiedName the qualified name of the element type to instantiate`
`41`	`41`	`* @param page the HtmlPage that contains this element`
Original file line number	Diff line number	Diff line change
`@@ -417,10 +417,10 @@ public List<NameValuePair> getParameterListForSubmit(final SubmittableElement su`
`417`	`417`	`* @return the page contained by this form's window after the reset`
`418`	`418`	`*/`
`419`	`419`	`public Page reset() {`
`420`		`- final SgmlPage htmlPage = getPage();`
	`420`	`+ final SgmlPage sgmlPage = getPage();`
`421`	`421`	`final ScriptResult scriptResult = fireEvent(Event.TYPE_RESET);`
`422`	`422`	`if (ScriptResult.isFalse(scriptResult)) {`
`423`		`- return htmlPage.getWebClient().getCurrentWindow().getEnclosedPage();`
	`423`	`+ return sgmlPage.getWebClient().getCurrentWindow().getEnclosedPage();`
`424`	`424`	`}`
`425`	`425`
`426`	`426`	`for (final HtmlElement next : getHtmlElementDescendants()) {`
`@@ -429,7 +429,7 @@ public Page reset() {`
`429`	`429`	`}`
`430`	`430`	`}`
`431`	`431`
`432`		`- return htmlPage;`
	`432`	`+ return sgmlPage;`
`433`	`433`	`}`
`434`	`434`
`435`	`435`	`/**`
`@@ -490,7 +490,7 @@ private static boolean isValidForSubmission(final HtmlElement element, final Sub`
`490`	`490`	`return ((HtmlInput) element).isChecked();`
`491`	`491`	`}`
`492`	`492`	`}`
`493`		`- if (HtmlSelect.TAG_NAME.equals(tagName)) {`
	`493`	`+ if (element instanceof HtmlSelect) {`
`494`	`494`	`return ((HtmlSelect) element).isValidForSubmission();`
`495`	`495`	`}`
`496`	`496`	`return true;`
Original file line number	Diff line number	Diff line change
`@@ -175,7 +175,7 @@ public NamedNodeMap getAttributes() {`
`175`	`175`	`}`
`176`	`176`
`177`	`177`	`/**`
`178`		`- * Creates the JS object for the property attributes. This object will the be cached.`
	`178`	`+ * Creates the JS object for the property attributes. This object will be cached.`
`179`	`179`	`* @return the JS object`
`180`	`180`	`*/`
`181`	`181`	`protected NamedNodeMap createAttributesObject() {`
`@@ -636,7 +636,7 @@ public HTMLCollection getElementsByClassName(final String className) {`
`636`	`636`	`}`
`637`	`637`	`String classAttribute = ((HtmlElement) node).getAttributeDirect("class");`
`638`	`638`	`if (ATTRIBUTE_NOT_DEFINED == classAttribute) {`
`639`		`- return false; // probably better performance as most of elements won't have a class attribute`
	`639`	`+ return false; // probably better performance as most elements won't have a class attribute`
`640`	`640`	`}`
`641`	`641`
`642`	`642`	`classAttribute = " " + classAttribute + " ";`
`@@ -760,7 +760,7 @@ private Object[] getInsertAdjacentLocation(final String where) {`
`760`	`760`	`// compute the where and how the new nodes should be added`
`761`	`761`	`if (POSITION_AFTER_BEGIN.equalsIgnoreCase(where)) {`
`762`	`762`	`if (currentNode.getFirstChild() == null) {`
`763`		`- // new nodes should appended to the children of current node`
	`763`	`+ // new nodes should append to the children of current node`
`764`	`764`	`node = currentNode;`
`765`	`765`	`append = true;`
`766`	`766`	`}`
`@@ -776,13 +776,13 @@ else if (POSITION_BEFORE_BEGIN.equalsIgnoreCase(where)) {`
`776`	`776`	`append = false;`
`777`	`777`	`}`
`778`	`778`	`else if (POSITION_BEFORE_END.equalsIgnoreCase(where)) {`
`779`		`- // new nodes should appended to the children of current node`
	`779`	`+ // new nodes should append to the children of current node`
`780`	`780`	`node = currentNode;`
`781`	`781`	`append = true;`
`782`	`782`	`}`
`783`	`783`	`else if (POSITION_AFTER_END.equalsIgnoreCase(where)) {`
`784`	`784`	`if (currentNode.getNextSibling() == null) {`
`785`		`- // new nodes should appended to the children of parent node`
	`785`	`+ // new nodes should append to the children of parent node`
`786`	`786`	`node = currentNode.getParentNode();`
`787`	`787`	`append = true;`
`788`	`788`	`}`