Browse Source

Checkstyle: require braces around do, for, and while clauses (#103217)

* Checkstyle requires braces after for, do, while
William Brafford 1 year ago
parent
commit
d07651f8b9
15 changed files with 45 additions and 19 deletions
  1. 7 0
      build-tools-internal/src/main/resources/checkstyle.xml
  2. 2 1
      libs/h3/src/main/java/org/elasticsearch/h3/HexRing.java
  3. 4 2
      modules/analysis-common/src/main/java/org/elasticsearch/analysis/common/WordDelimiterTokenFilterFactory.java
  4. 2 1
      server/src/internalClusterTest/java/org/elasticsearch/indices/mapping/UpdateMappingIntegrationIT.java
  5. 2 1
      server/src/main/java/org/elasticsearch/common/collect/EvictingQueue.java
  6. 2 1
      server/src/main/java/org/elasticsearch/common/lucene/search/MultiPhrasePrefixQuery.java
  7. 2 1
      server/src/main/java/org/elasticsearch/search/aggregations/bucket/range/IpRangeAggregationBuilder.java
  8. 2 1
      server/src/main/java/org/elasticsearch/transport/TcpTransport.java
  9. 2 1
      server/src/test/java/org/elasticsearch/action/termvectors/AbstractTermVectorsTestCase.java
  10. 2 1
      x-pack/plugin/analytics/src/test/java/org/elasticsearch/xpack/analytics/stringstats/StringStatsAggregatorTests.java
  11. 2 1
      x-pack/plugin/core/src/main/java/org/elasticsearch/license/CryptUtils.java
  12. 2 1
      x-pack/plugin/core/src/main/java/org/elasticsearch/protocol/xpack/common/ProtocolUtils.java
  13. 8 4
      x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authc/support/BCrypt.java
  14. 4 2
      x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/aggs/frequentitemsets/ItemSetBitSet.java
  15. 2 1
      x-pack/plugin/old-lucene-versions/src/main/java/org/elasticsearch/xpack/lucene/bwc/codecs/lucene54/LegacyStringHelper.java

+ 7 - 0
build-tools-internal/src/main/resources/checkstyle.xml

@@ -194,5 +194,12 @@
             value="Do not negate boolean expressions with '!', but check explicitly with '== false' as it is more explicit"/>
     </module>
 
+    <module name="NeedBraces">
+        <!-- We have many generated equals classes with LITERAL_IF and no braces, so we don't check IF or ELSE -->
+        <property name="tokens" value="LITERAL_DO,LITERAL_FOR,LITERAL_WHILE"/>
+        <property name="allowSingleLineStatement" value="false"/>
+        <property name="allowEmptyLoopBody" value="true"/>
+    </module>
+
   </module>
 </module>

+ 2 - 1
libs/h3/src/main/java/org/elasticsearch/h3/HexRing.java

@@ -775,8 +775,9 @@ final class HexRing {
                 current = H3Index.h3RotatePent60ccw(current);
             }
         } else {
-            for (int i = 0; i < newRotations; i++)
+            for (int i = 0; i < newRotations; i++) {
                 current = H3Index.h3Rotate60ccw(current);
+            }
         }
         return current;
     }

+ 4 - 2
modules/analysis-common/src/main/java/org/elasticsearch/analysis/common/WordDelimiterTokenFilterFactory.java

@@ -124,10 +124,12 @@ public class WordDelimiterTokenFilterFactory extends AbstractTokenFilterFactory
 
         // ensure the table is always at least as big as DEFAULT_WORD_DELIM_TABLE for performance
         byte types[] = new byte[Math.max(typeMap.lastKey() + 1, WordDelimiterIterator.DEFAULT_WORD_DELIM_TABLE.length)];
-        for (int i = 0; i < types.length; i++)
+        for (int i = 0; i < types.length; i++) {
             types[i] = WordDelimiterIterator.getType(i);
-        for (Map.Entry<Character, Byte> mapping : typeMap.entrySet())
+        }
+        for (Map.Entry<Character, Byte> mapping : typeMap.entrySet()) {
             types[mapping.getKey()] = mapping.getValue();
+        }
         return types;
     }
 

+ 2 - 1
server/src/internalClusterTest/java/org/elasticsearch/indices/mapping/UpdateMappingIntegrationIT.java

@@ -236,8 +236,9 @@ public class UpdateMappingIntegrationIT extends ESIntegTestCase {
             threads[j].start();
         }
 
-        for (Thread t : threads)
+        for (Thread t : threads) {
             t.join();
+        }
 
         if (threadException.get() != null) {
             throw threadException.get();

+ 2 - 1
server/src/main/java/org/elasticsearch/common/collect/EvictingQueue.java

@@ -152,8 +152,9 @@ public class EvictingQueue<T> implements Queue<T> {
     @Override
     public boolean addAll(Collection<? extends T> c) {
         boolean modified = false;
-        for (T e : c)
+        for (T e : c) {
             if (add(e)) modified = true;
+        }
         return modified;
     }
 

+ 2 - 1
server/src/main/java/org/elasticsearch/common/lucene/search/MultiPhrasePrefixQuery.java

@@ -126,8 +126,9 @@ public class MultiPhrasePrefixQuery extends Query {
      */
     public int[] getPositions() {
         int[] result = new int[positions.size()];
-        for (int i = 0; i < positions.size(); i++)
+        for (int i = 0; i < positions.size(); i++) {
             result[i] = positions.get(i);
+        }
         return result;
     }
 

+ 2 - 1
server/src/main/java/org/elasticsearch/search/aggregations/bucket/range/IpRangeAggregationBuilder.java

@@ -61,8 +61,9 @@ public final class IpRangeAggregationBuilder extends ValuesSourceAggregationBuil
         PARSER.declareBoolean(IpRangeAggregationBuilder::keyed, RangeAggregator.KEYED_FIELD);
 
         PARSER.declareObjectArray((agg, ranges) -> {
-            for (Range range : ranges)
+            for (Range range : ranges) {
                 agg.addRange(range);
+            }
         }, (p, c) -> IpRangeAggregationBuilder.parseRange(p), RangeAggregator.RANGES_FIELD);
     }
 

+ 2 - 1
server/src/main/java/org/elasticsearch/transport/TcpTransport.java

@@ -255,8 +255,9 @@ public abstract class TcpTransport extends AbstractLifecycleComponent implements
                 : "expected channels size to be == " + connectionProfile.getNumConnections() + " but was: [" + channels.size() + "]";
             typeMapping = new EnumMap<>(TransportRequestOptions.Type.class);
             for (ConnectionProfile.ConnectionTypeHandle handle : connectionProfile.getHandles()) {
-                for (TransportRequestOptions.Type type : handle.getTypes())
+                for (TransportRequestOptions.Type type : handle.getTypes()) {
                     typeMapping.put(type, handle);
+                }
             }
             version = handshakeVersion;
             compress = connectionProfile.getCompressionEnabled();

+ 2 - 1
server/src/test/java/org/elasticsearch/action/termvectors/AbstractTermVectorsTestCase.java

@@ -224,10 +224,11 @@ public abstract class AbstractTermVectorsTestCase extends ESIntegTestCase {
                 if (randomBoolean()) {
                     selectedFields.add("Doesnt_exist"); // this will be ignored.
                 }
-                for (TestFieldSetting field : fieldSettings)
+                for (TestFieldSetting field : fieldSettings) {
                     if (randomBoolean()) {
                         selectedFields.add(field.name);
                     }
+                }
 
                 if (selectedFields.size() == 0) {
                     selectedFields = null; // 0 length set is not supported.

+ 2 - 1
x-pack/plugin/analytics/src/test/java/org/elasticsearch/xpack/analytics/stringstats/StringStatsAggregatorTests.java

@@ -226,10 +226,11 @@ public class StringStatsAggregatorTests extends AggregatorTestCase {
         RandomIndexWriter indexWriter = new RandomIndexWriter(random(), directory);
         final int numDocs = 10;
         for (int i = 0; i < numDocs; i++) {
-            for (int j = 0; j < 4; j++)
+            for (int j = 0; j < 4; j++) {
                 indexWriter.addDocument(
                     List.of(new NumericDocValuesField("value", i + 1), new TextField("text", "test" + j, Field.Store.NO))
                 );
+            }
         }
         indexWriter.close();
 

+ 2 - 1
x-pack/plugin/core/src/main/java/org/elasticsearch/license/CryptUtils.java

@@ -226,8 +226,9 @@ public class CryptUtils {
         byte[] out = new byte[length + 1];
 
         int i = 0;
-        for (; i < bytes.length; i++)
+        for (; i < bytes.length; i++) {
             out[i] = bytes[i];
+        }
 
         int padded = length - i;
 

+ 2 - 1
x-pack/plugin/core/src/main/java/org/elasticsearch/protocol/xpack/common/ProtocolUtils.java

@@ -52,8 +52,9 @@ public final class ProtocolUtils {
      */
     public static int hashCode(Map<String, String[]> a) {
         int hash = 0;
-        for (Map.Entry<String, String[]> entry : a.entrySet())
+        for (Map.Entry<String, String[]> entry : a.entrySet()) {
             hash += Arrays.hashCode(entry.getValue());
+        }
         return hash;
     }
 }

+ 8 - 4
x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authc/support/BCrypt.java

@@ -1416,8 +1416,9 @@ public class BCrypt {
         }
 
         ret = new byte[olen];
-        for (off = 0; off < olen; off++)
+        for (off = 0; off < olen; off++) {
             ret[off] = (byte) rs.charAt(off);
+        }
         return ret;
     }
 
@@ -1489,8 +1490,9 @@ public class BCrypt {
         int lr[] = { 0, 0 };
         int plen = P.length, slen = S.length;
 
-        for (i = 0; i < plen; i++)
+        for (i = 0; i < plen; i++) {
             P[i] = P[i] ^ streamtoword(key, koffp);
+        }
 
         for (i = 0; i < plen; i += 2) {
             encipher(lr, 0);
@@ -1518,8 +1520,9 @@ public class BCrypt {
         int lr[] = { 0, 0 };
         int plen = P.length, slen = S.length;
 
-        for (i = 0; i < plen; i++)
+        for (i = 0; i < plen; i++) {
             P[i] = P[i] ^ streamtoword(key, koffp);
+        }
 
         for (i = 0; i < plen; i += 2) {
             lr[0] ^= streamtoword(data, doffp);
@@ -1565,8 +1568,9 @@ public class BCrypt {
         }
 
         for (i = 0; i < 64; i++) {
-            for (j = 0; j < (clen >> 1); j++)
+            for (j = 0; j < (clen >> 1); j++) {
                 encipher(cdata, j << 1);
+            }
         }
 
         ret = new byte[clen * 4];

+ 4 - 2
x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/aggs/frequentitemsets/ItemSetBitSet.java

@@ -235,8 +235,9 @@ class ItemSetBitSet implements Cloneable {
         if (wordsInUse != set.wordsInUse) return false;
 
         // Check words in use by both BitSets
-        for (int i = 0; i < wordsInUse; i++)
+        for (int i = 0; i < wordsInUse; i++) {
             if (words[i] != set.words[i]) return false;
+        }
 
         return true;
     }
@@ -266,8 +267,9 @@ class ItemSetBitSet implements Cloneable {
     private void recalculateWordsInUse() {
         // Traverse the bitset until a used word is found
         int i;
-        for (i = wordsInUse - 1; i >= 0; i--)
+        for (i = wordsInUse - 1; i >= 0; i--) {
             if (words[i] != 0) break;
+        }
 
         wordsInUse = i + 1; // The new logical size
     }

+ 2 - 1
x-pack/plugin/old-lucene-versions/src/main/java/org/elasticsearch/xpack/lucene/bwc/codecs/lucene54/LegacyStringHelper.java

@@ -44,8 +44,9 @@ abstract class LegacyStringHelper {
         final int offLeft = left.offset;
         byte[] bytesRight = right.bytes;
         final int offRight = right.offset;
-        for (int i = 0; i < len; i++)
+        for (int i = 0; i < len; i++) {
             if (bytesLeft[i + offLeft] != bytesRight[i + offRight]) return i;
+        }
         return len;
     }