ref: Rename variables. (#209)

bgrozev · web-flow · commit 686164ffc463 · 2020-06-10T15:15:11.000-05:00
diff --git a/src/main/java/org/ice4j/ice/Agent.java b/src/main/java/org/ice4j/ice/Agent.java
@@ -1466,44 +1466,45 @@ public boolean isControlling()
 
     /**
      * Returns the local <tt>LocalCandidate</tt> with the specified
-     * <tt>localAddress</tt> if it belongs to any of this {@link Agent}'s
+     * <tt>address</tt> if it belongs to any of this {@link Agent}'s
      * streams or <tt>null</tt> if it doesn't.
      *
-     * @param localAddress the {@link TransportAddress} we are looking for.
+     * @param address the {@link TransportAddress} we are looking for.
      *
      * @return the local <tt>LocalCandidate</tt> with the specified
-     * <tt>localAddress</tt> if it belongs to any of this {@link Agent}'s
+     * <tt>address</tt> if it belongs to any of this {@link Agent}'s
      * streams or <tt>null</tt> if it doesn't.
      */
-    public LocalCandidate findLocalCandidate(TransportAddress localAddress)
+    public LocalCandidate findLocalCandidate(TransportAddress address)
     {
-        return findLocalCandidate(localAddress, null);
+        return findLocalCandidate(address, null);
     }
 
     /**
      * Returns the local <tt>LocalCandidate</tt> with the specified
-     * <tt>localAddress</tt> if it belongs to any of this {@link Agent}'s
+     * <tt>address</tt> if it belongs to any of this {@link Agent}'s
      * streams or <tt>null</tt> if it doesn't. If {@code base} is also specified,
      * tries to find a candidate whose base matches {@code base}.
      *
-     * @param localAddress the {@link TransportAddress} we are looking for.
+     * @param address the {@link TransportAddress} we are looking for.
      * @param base an optional base to match.
      *
      * @return the local <tt>LocalCandidate</tt> with the specified
-     * <tt>localAddress</tt> if it belongs to any of this {@link Agent}'s
+     * <tt>address</tt> if it belongs to any of this {@link Agent}'s
      * streams or <tt>null</tt> if it doesn't.
      */
     public LocalCandidate findLocalCandidate(
-            TransportAddress localAddress,
+            TransportAddress address,
             LocalCandidate base)
     {
         for (IceMediaStream stream : mediaStreams.values())
         {
-            LocalCandidate cnd = stream.findLocalCandidate(localAddress, base);
+            LocalCandidate localCandidate
+                    = stream.findLocalCandidate(address, base);
 
-            if (cnd != null)
+            if (localCandidate != null)
             {
-                return cnd;
+                return localCandidate;
             }
         }
         return null;
diff --git a/src/main/java/org/ice4j/ice/Component.java b/src/main/java/org/ice4j/ice/Component.java
@@ -925,41 +925,41 @@ public LocalCandidate findLocalCandidate(TransportAddress localAddress)
 
     /**
      * Returns the local <tt>LocalCandidate</tt> with the specified
-     * <tt>localAddress</tt> if it belongs to this component or <tt>null</tt>
+     * <tt>address</tt> if it belongs to this component or <tt>null</tt>
      * if it doesn't. If {@code base} is also specified, tries to find a
      * candidate whose base matches {@code base}.
      *
-     * @param localAddress the {@link TransportAddress} we are looking for.
+     * @param address the {@link TransportAddress} we are looking for.
      * @param base an optional base to match.
      *
      * @return  the local <tt>LocalCandidate</tt> with the specified
-     * <tt>localAddress</tt> if it belongs to this component or <tt>null</tt>
+     * <tt>address</tt> if it belongs to this component or <tt>null</tt>
      * if it doesn't.
      */
-    public LocalCandidate findLocalCandidate(TransportAddress localAddress, LocalCandidate base)
+    public LocalCandidate findLocalCandidate(TransportAddress address, LocalCandidate base)
     {
-        for (LocalCandidate localCnd : localCandidates)
+        for (LocalCandidate localCandidate : localCandidates)
         {
-            if (localCnd.getTransportAddress().equals(localAddress))
+            if (localCandidate.getTransportAddress().equals(address))
             {
-                if (base == null || base.equals(localCnd.getBase()))
+                if (base == null || base.equals(localCandidate.getBase()))
                 {
-                    return localCnd;
+                    return localCandidate;
                 }
             }
         }
         // In case the above loop failed to find a result because `base` was
         // specified, fallback to the original behavior and return the first
-        // candidate matching `localAddress` regardless of `base`.
-        for (LocalCandidate localCnd : localCandidates)
+        // candidate matching `address` regardless of `base`.
+        for (LocalCandidate localCandidate : localCandidates)
         {
-            if (localCnd.getTransportAddress().equals(localAddress))
+            if (localCandidate.getTransportAddress().equals(address))
             {
                 logger.warn("Returning a candidate matching the address, "
                         + "while no candidates match both address ("
-                        + localAddress + ") and base (" + base +"): " + localCnd
-                        + " with base " + localCnd.getBase());
-                return localCnd;
+                        + address + ") and base (" + base +"): " + localCandidate
+                        + " with base " + localCandidate.getBase());
+                return localCandidate;
             }
         }
 
diff --git a/src/main/java/org/ice4j/ice/IceMediaStream.java b/src/main/java/org/ice4j/ice/IceMediaStream.java
@@ -507,26 +507,27 @@ protected void setMaxCheckListSize(int nSize)
 
     /**
      * Returns the local <tt>LocalCandidate</tt> with the specified
-     * <tt>localAddress</tt> if it belongs to any of this stream's components
+     * <tt>address</tt> if it belongs to any of this stream's components
      * or <tt>null</tt> otherwise. If {@code base} is also specified, tries to
      * find a candidate whose base matches {@code base}.
      *
-     * @param localAddress the {@link TransportAddress} we are looking for.
+     * @param address the {@link TransportAddress} we are looking for.
      * @param base an optional base to match.
      *
      * @return  the local <tt>LocalCandidate</tt> with the specified
-     * <tt>localAddress</tt> if it belongs to any of this stream's components
+     * <tt>address</tt> if it belongs to any of this stream's components
      * or <tt>null</tt> otherwise.
      */
-    public LocalCandidate findLocalCandidate(TransportAddress localAddress, LocalCandidate base)
+    public LocalCandidate findLocalCandidate(TransportAddress address, LocalCandidate base)
     {
-        for (Component cmp : components.values())
+        for (Component component : components.values())
         {
-            LocalCandidate cnd = cmp.findLocalCandidate(localAddress, base);
+            LocalCandidate localCandidate
+                    = component.findLocalCandidate(address, base);
 
-            if (cnd != null)
+            if (localCandidate != null)
             {
-                return cnd;
+                return localCandidate;
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -1466,44 +1466,45 @@ public boolean isControlling()`
`1466`	`1466`
`1467`	`1467`	`/**`
`1468`	`1468`	`* Returns the local <tt>LocalCandidate</tt> with the specified`
`1469`		`- * <tt>localAddress</tt> if it belongs to any of this {@link Agent}'s`
	`1469`	`+ * <tt>address</tt> if it belongs to any of this {@link Agent}'s`
`1470`	`1470`	`* streams or <tt>null</tt> if it doesn't.`
`1471`	`1471`	`*`
`1472`		`- * @param localAddress the {@link TransportAddress} we are looking for.`
	`1472`	`+ * @param address the {@link TransportAddress} we are looking for.`
`1473`	`1473`	`*`
`1474`	`1474`	`* @return the local <tt>LocalCandidate</tt> with the specified`
`1475`		`- * <tt>localAddress</tt> if it belongs to any of this {@link Agent}'s`
	`1475`	`+ * <tt>address</tt> if it belongs to any of this {@link Agent}'s`
`1476`	`1476`	`* streams or <tt>null</tt> if it doesn't.`
`1477`	`1477`	`*/`
`1478`		`- public LocalCandidate findLocalCandidate(TransportAddress localAddress)`
	`1478`	`+ public LocalCandidate findLocalCandidate(TransportAddress address)`
`1479`	`1479`	`{`
`1480`		`- return findLocalCandidate(localAddress, null);`
	`1480`	`+ return findLocalCandidate(address, null);`
`1481`	`1481`	`}`
`1482`	`1482`
`1483`	`1483`	`/**`
`1484`	`1484`	`* Returns the local <tt>LocalCandidate</tt> with the specified`
`1485`		`- * <tt>localAddress</tt> if it belongs to any of this {@link Agent}'s`
	`1485`	`+ * <tt>address</tt> if it belongs to any of this {@link Agent}'s`
`1486`	`1486`	`* streams or <tt>null</tt> if it doesn't. If {@code base} is also specified,`
`1487`	`1487`	`* tries to find a candidate whose base matches {@code base}.`
`1488`	`1488`	`*`
`1489`		`- * @param localAddress the {@link TransportAddress} we are looking for.`
	`1489`	`+ * @param address the {@link TransportAddress} we are looking for.`
`1490`	`1490`	`* @param base an optional base to match.`
`1491`	`1491`	`*`
`1492`	`1492`	`* @return the local <tt>LocalCandidate</tt> with the specified`
`1493`		`- * <tt>localAddress</tt> if it belongs to any of this {@link Agent}'s`
	`1493`	`+ * <tt>address</tt> if it belongs to any of this {@link Agent}'s`
`1494`	`1494`	`* streams or <tt>null</tt> if it doesn't.`
`1495`	`1495`	`*/`
`1496`	`1496`	`public LocalCandidate findLocalCandidate(`
`1497`		`- TransportAddress localAddress,`
	`1497`	`+ TransportAddress address,`
`1498`	`1498`	`LocalCandidate base)`
`1499`	`1499`	`{`
`1500`	`1500`	`for (IceMediaStream stream : mediaStreams.values())`
`1501`	`1501`	`{`
`1502`		`- LocalCandidate cnd = stream.findLocalCandidate(localAddress, base);`
	`1502`	`+ LocalCandidate localCandidate`
	`1503`	`+ = stream.findLocalCandidate(address, base);`
`1503`	`1504`
`1504`		`- if (cnd != null)`
	`1505`	`+ if (localCandidate != null)`
`1505`	`1506`	`{`
`1506`		`- return cnd;`
	`1507`	`+ return localCandidate;`
`1507`	`1508`	`}`
`1508`	`1509`	`}`
`1509`	`1510`	`return null;`
Original file line number	Diff line number	Diff line change
`@@ -925,41 +925,41 @@ public LocalCandidate findLocalCandidate(TransportAddress localAddress)`
`925`	`925`
`926`	`926`	`/**`
`927`	`927`	`* Returns the local <tt>LocalCandidate</tt> with the specified`
`928`		`- * <tt>localAddress</tt> if it belongs to this component or <tt>null</tt>`
	`928`	`+ * <tt>address</tt> if it belongs to this component or <tt>null</tt>`
`929`	`929`	`* if it doesn't. If {@code base} is also specified, tries to find a`
`930`	`930`	`* candidate whose base matches {@code base}.`
`931`	`931`	`*`
`932`		`- * @param localAddress the {@link TransportAddress} we are looking for.`
	`932`	`+ * @param address the {@link TransportAddress} we are looking for.`
`933`	`933`	`* @param base an optional base to match.`
`934`	`934`	`*`
`935`	`935`	`* @return the local <tt>LocalCandidate</tt> with the specified`
`936`		`- * <tt>localAddress</tt> if it belongs to this component or <tt>null</tt>`
	`936`	`+ * <tt>address</tt> if it belongs to this component or <tt>null</tt>`
`937`	`937`	`* if it doesn't.`
`938`	`938`	`*/`
`939`		`- public LocalCandidate findLocalCandidate(TransportAddress localAddress, LocalCandidate base)`
	`939`	`+ public LocalCandidate findLocalCandidate(TransportAddress address, LocalCandidate base)`
`940`	`940`	`{`
`941`		`- for (LocalCandidate localCnd : localCandidates)`
	`941`	`+ for (LocalCandidate localCandidate : localCandidates)`
`942`	`942`	`{`
`943`		`- if (localCnd.getTransportAddress().equals(localAddress))`
	`943`	`+ if (localCandidate.getTransportAddress().equals(address))`
`944`	`944`	`{`
`945`		`- if (base == null \|\| base.equals(localCnd.getBase()))`
	`945`	`+ if (base == null \|\| base.equals(localCandidate.getBase()))`
`946`	`946`	`{`
`947`		`- return localCnd;`
	`947`	`+ return localCandidate;`
`948`	`948`	`}`
`949`	`949`	`}`
`950`	`950`	`}`
`951`	`951`	// In case the above loop failed to find a result because `base` was
`952`	`952`	`// specified, fallback to the original behavior and return the first`
`953`		- // candidate matching `localAddress` regardless of `base`.
`954`		`- for (LocalCandidate localCnd : localCandidates)`
	`953`	+ // candidate matching `address` regardless of `base`.
	`954`	`+ for (LocalCandidate localCandidate : localCandidates)`
`955`	`955`	`{`
`956`		`- if (localCnd.getTransportAddress().equals(localAddress))`
	`956`	`+ if (localCandidate.getTransportAddress().equals(address))`
`957`	`957`	`{`
`958`	`958`	`logger.warn("Returning a candidate matching the address, "`
`959`	`959`	`+ "while no candidates match both address ("`
`960`		`- + localAddress + ") and base (" + base +"): " + localCnd`
`961`		`- + " with base " + localCnd.getBase());`
`962`		`- return localCnd;`
	`960`	`+ + address + ") and base (" + base +"): " + localCandidate`
	`961`	`+ + " with base " + localCandidate.getBase());`
	`962`	`+ return localCandidate;`
`963`	`963`	`}`
`964`	`964`	`}`
`965`	`965`
Original file line number	Diff line number	Diff line change
`@@ -507,26 +507,27 @@ protected void setMaxCheckListSize(int nSize)`
`507`	`507`
`508`	`508`	`/**`
`509`	`509`	`* Returns the local <tt>LocalCandidate</tt> with the specified`
`510`		`- * <tt>localAddress</tt> if it belongs to any of this stream's components`
	`510`	`+ * <tt>address</tt> if it belongs to any of this stream's components`
`511`	`511`	`* or <tt>null</tt> otherwise. If {@code base} is also specified, tries to`
`512`	`512`	`* find a candidate whose base matches {@code base}.`
`513`	`513`	`*`
`514`		`- * @param localAddress the {@link TransportAddress} we are looking for.`
	`514`	`+ * @param address the {@link TransportAddress} we are looking for.`
`515`	`515`	`* @param base an optional base to match.`
`516`	`516`	`*`
`517`	`517`	`* @return the local <tt>LocalCandidate</tt> with the specified`
`518`		`- * <tt>localAddress</tt> if it belongs to any of this stream's components`
	`518`	`+ * <tt>address</tt> if it belongs to any of this stream's components`
`519`	`519`	`* or <tt>null</tt> otherwise.`
`520`	`520`	`*/`
`521`		`- public LocalCandidate findLocalCandidate(TransportAddress localAddress, LocalCandidate base)`
	`521`	`+ public LocalCandidate findLocalCandidate(TransportAddress address, LocalCandidate base)`
`522`	`522`	`{`
`523`		`- for (Component cmp : components.values())`
	`523`	`+ for (Component component : components.values())`
`524`	`524`	`{`
`525`		`- LocalCandidate cnd = cmp.findLocalCandidate(localAddress, base);`
	`525`	`+ LocalCandidate localCandidate`
	`526`	`+ = component.findLocalCandidate(address, base);`
`526`	`527`
`527`		`- if (cnd != null)`
	`528`	`+ if (localCandidate != null)`
`528`	`529`	`{`
`529`		`- return cnd;`
	`530`	`+ return localCandidate;`
`530`	`531`	`}`
`531`	`532`	`}`
`532`	`533`