Rename new class name with camel case

Javadoc

Author: garydgregory

…g/apache/commons/codec/digest/CRC16.java …g/apache/commons/codec/digest/Crc16.javasrc/main/java/org/apache/commons/codec/digest/CRC16.java renamed to src/main/java/org/apache/commons/codec/digest/Crc16.java src/main/java/org/apache/commons/codec/digest/CRC16.java renamed to src/main/java/org/apache/commons/codec/digest/Crc16.java

@@ -31,7 +31,6 @@
  * </p>
  *
  * <pre>
- *
  * Checksum crc16 = CRC16.builder().setTable(CRC16.getModbusTable()).setInit(0x0000).get();
  * </pre>
  *
@@ -41,12 +40,12 @@
  * @see <a href="https://crccalc.com/?crc=123456789&method=&datatype=ascii&outtype=hex">crccalc</a>
  * @since 1.20.0
  */
-public class CRC16 implements Checksum {
+public final class Crc16 implements Checksum {
 
     /**
-     * Builds CRC16 instances.
+     * Builds {@link Crc16} instances.
      */
-    public static class Builder implements Supplier<CRC16> {
+    public static final class Builder implements Supplier<Crc16> {
 
         private int init;
         private int[] table;
@@ -60,11 +59,11 @@ public Builder() {
         }
 
         /**
-         * Creates a new {@link CRC16} instance.
+         * Creates a new {@link Crc16} instance.
          */
         @Override
-        public CRC16 get() {
-            return new CRC16(this);
+        public Crc16 get() {
+            return new Crc16(this);
         }
 
         /**
@@ -89,7 +88,7 @@ public Builder setTable(final int[] table) {
         }
 
         /**
-         * Sets the XorOut value to XOR to the current checksum returned by {@link CRC16#getValue()}.
+         * Sets the XorOut value to XOR to the current checksum returned by {@link Crc16#getValue()}.
          *
          * @param xorOut the XorOut value.
          * @return {@code this} instance.
@@ -270,6 +269,7 @@ private Builder table(final int[] table) {
 
     /**
      * Creates a new CRC16-CCITT Checksum.
+     *
      * <ul>
      * <li>The init value is {@code 0x0000}.</li>
      * <li>The XorOut value is {@code 0x0000}.</li>
@@ -287,12 +287,13 @@ private Builder table(final int[] table) {
      *
      * @return a new CRC16-CCITT Checksum.
      */
-    public static CRC16 arc() {
+    public static Crc16 arc() {
         return builder().setInit(ARC_INIT).table(ARC).get();
     }
 
     /**
      * Creates a new builder.
+     *
      * <p>
      * Since there are so many CRC-16 variants, we do not pick a default.
      * </p>
@@ -324,20 +325,21 @@ public static Builder builder() {
      *
      * @return a new CRC16-CCITT Checksum.
      */
-    public static CRC16 ccitt() {
+    public static Crc16 ccitt() {
         return builder().setInit(CCITT_INIT).table(CCITT).get();
     }
 
     /**
      * Creates a new CRC16-DNP Checksum.
+     *
      * <ul>
      * <li>The init value is {@code 0x0000}.</li>
      * <li>The XorOut value is {@code 0xFFFF}.</li>
      * </ul>
      *
      * @return a new CRC16-DNP Checksum.
      */
-    public static CRC16 dnp() {
+    public static Crc16 dnp() {
         return builder().setInit(DNP_INIT).setXorOut(DNP_XOROUT).table(DNP).get();
     }
 
@@ -415,6 +417,7 @@ public static int[] getNrsc5Table() {
 
     /**
      * Creates a new CRC16-IBM-SDLC Checksum.
+     *
      * <ul>
      * <li>The init value is {@code 0xFFFF}.</li>
      * <li>The XorOut value is {@code 0xFFFF}.</li>
@@ -433,12 +436,13 @@ public static int[] getNrsc5Table() {
      *
      * @return a new CRC16-IBM-SDLC Checksum.
      */
-    public static CRC16 ibmSdlc() {
+    public static Crc16 ibmSdlc() {
         return builder().setInit(IBM_SDLC_INIT).setXorOut(IBM_SDLC_XOROUT).table(IBM_SDLC).get();
     }
 
     /**
      * Creates a new instance for CRC16-MAXIM Checksum.
+     *
      * <p>
      * CRC-16 checksum implementation based on polynomial {@code x<sup>16</spu> + x^15 + x^2 + 1 (0x8005)}.
      * </p>
@@ -455,25 +459,27 @@ public static CRC16 ibmSdlc() {
      *
      * @return a new CRC16-MAXIM Checksum.
      */
-    public static CRC16 maxim() {
+    public static Crc16 maxim() {
         return builder().setInit(MAXIM_INIT).setXorOut(MAXIM_XOROUT).table(MAXIM).get();
     }
 
     /**
      * Creates a new instance for CRC16-MCRF4XX Checksum.
+     *
      * <ul>
      * <li>The init value is {@code 0xFFFF}.</li>
      * <li>The XorOut value is {@code 0x0000}.</li>
      * </ul>
      *
      * @return a new CRC16-MCRF4XX Checksum.
      */
-    public static CRC16 mcrf4xx() {
+    public static Crc16 mcrf4xx() {
         return builder().setInit(MCRF4XX_INIT).table(MCRF4XX).get();
     }
 
     /**
      * Creates a new instance for CRC16-MODBUS Checksum.
+     *
      * <p>
      * CRC-16 checksum implementation based on polynomial {@code x<sup>16</spu> + x^15 + x^2 + 1 (0x8005)}.
      * </p>
@@ -491,33 +497,35 @@ public static CRC16 mcrf4xx() {
      *
      * @return a new CRC16-MODBUS Checksum.
      */
-    public static CRC16 modbus() {
+    public static Crc16 modbus() {
         return builder().setInit(MODBUS_INIT).table(MODBUS).get();
     }
 
     /**
      * Creates a new instance for CRC16-NRSC-5 Checksum.
+     *
      * <ul>
      * <li>The init value is {@code 0xFFFF}.</li>
      * <li>The XorOut value is {@code 0x0000}.</li>
      * </ul>
      *
      * @return a new CRC16-NRSC-5 Checksum.
      */
-    public static CRC16 nrsc5() {
+    public static Crc16 nrsc5() {
         return builder().setInit(NRSC5_INIT).table(NRSC5).get();
     }
 
     /**
      * Creates a new instance for CRC16-USB Checksum.
+     *
      * <ul>
      * <li>The init value is {@code 0xFFFF}.</li>
      * <li>The XorOut value is {@code 0xFFFF}.</li>
      * </ul>
      *
      * @return a new CRC16-USB Checksum.
      */
-    public static CRC16 usb() {
+    public static Crc16 usb() {
         return builder().setInit(USB_INIT).setXorOut(USB_XOROUT).table(USB).get();
     }
 
@@ -532,7 +540,7 @@ public static CRC16 usb() {
     /**
      * Constructs a new instance.
      */
-    private CRC16(final Builder builder) {
+    private Crc16(final Builder builder) {
         this.init = builder.init;
         this.xorOut = builder.xorOut;
         this.crc = builder.init;
@@ -551,7 +559,7 @@ public void reset() {
 
     @Override
     public String toString() {
-        return String.format("CRC16 [init=0x%04X, crc=0x%04X, xorOut=0x%04X, crc^xorOut=0x%04X]", init, crc, xorOut, getValue());
+        return String.format("%s [init=0x%04X, crc=0x%04X, xorOut=0x%04X, crc^xorOut=0x%04X]", getClass().getSimpleName(), init, crc, xorOut, getValue());
     }
 
     @Override

…ache/commons/codec/digest/CRC16Test.java …ache/commons/codec/digest/Crc16Test.javasrc/test/java/org/apache/commons/codec/digest/CRC16Test.java renamed to src/test/java/org/apache/commons/codec/digest/Crc16Test.java src/test/java/org/apache/commons/codec/digest/CRC16Test.java renamed to src/test/java/org/apache/commons/codec/digest/Crc16Test.java

@@ -34,9 +34,9 @@
 import org.junit.jupiter.params.provider.MethodSource;
 
 /**
- * Tests {@link CRC16}.
+ * Tests {@link Crc16}.
  */
-class CRC16Test {
+class Crc16Test {
 
     private static final String BIG_TEXT = Uncheck.get(() -> PathUtils.readString(Paths.get("LICENSE.txt"), StandardCharsets.US_ASCII));
     private static final byte[] TEST_BYTES = "123456789".getBytes(StandardCharsets.US_ASCII);
@@ -100,13 +100,13 @@ static Object[][] testDnpDefault() {
     static Supplier<int[]>[] testGetTables() {
         // @formatter:off
         return new Supplier[] {
-            CRC16::getArcTable,
-            CRC16::getCcittTable,
-            CRC16::getDnpTable,
-            CRC16::getMcrf4xxTable,
-            CRC16::getMaximTable,
-            CRC16::getModbusTable,
-            CRC16::getNrsc5Table
+            Crc16::getArcTable,
+            Crc16::getCcittTable,
+            Crc16::getDnpTable,
+            Crc16::getMcrf4xxTable,
+            Crc16::getMaximTable,
+            Crc16::getModbusTable,
+            Crc16::getNrsc5Table
         };
         // @formatter:on
     }
@@ -230,19 +230,19 @@ void stdUpdate(final Checksum crc16) {
     @ParameterizedTest
     @MethodSource
     void testArcDefault(final String source, final long expected) {
-        testUpdateReset(source, expected, CRC16.arc());
+        testUpdateReset(source, expected, Crc16.arc());
     }
 
     @ParameterizedTest
     @MethodSource
     void testCcittDefault(final String source, final long expected) {
-        testUpdateReset(source, expected, CRC16.ccitt());
+        testUpdateReset(source, expected, Crc16.ccitt());
     }
 
     @ParameterizedTest
     @MethodSource
     void testDnpDefault(final String source, final long expected) {
-        testUpdateReset(source, expected, CRC16.dnp());
+        testUpdateReset(source, expected, Crc16.dnp());
     }
 
     @ParameterizedTest
@@ -257,12 +257,12 @@ void testGetTables(final Supplier<int[]> supplier) {
     @ParameterizedTest
     @MethodSource
     void testIbmSdlcDefault(final String source, final long expected) {
-        testUpdateReset(source, expected, CRC16.ibmSdlc());
+        testUpdateReset(source, expected, Crc16.ibmSdlc());
     }
 
     @Test
     void testInit() {
-        final Checksum crc16 = CRC16.builder().setTable(CRC16.getModbusTable()).setInit(0xFFFF).get();
+        final Checksum crc16 = Crc16.builder().setTable(Crc16.getModbusTable()).setInit(0xFFFF).get();
         stdUpdate(crc16);
         assertEquals(0x4B37, crc16.getValue());
         stdUpdate(crc16);
@@ -275,18 +275,18 @@ void testInit() {
     @ParameterizedTest
     @MethodSource
     void testMaximDefault(final String source, final long expected) {
-        testUpdateReset(source, expected, CRC16.maxim());
+        testUpdateReset(source, expected, Crc16.maxim());
     }
 
     @ParameterizedTest
     @MethodSource
     void testMcrf4xxDefault(final String source, final long expected) {
-        testUpdateReset(source, expected, CRC16.mcrf4xx());
+        testUpdateReset(source, expected, Crc16.mcrf4xx());
     }
 
     @Test
     void testModbusCustom() {
-        final Checksum crc16 = CRC16.builder().setTable(CRC16.getModbusTable()).setInit(0xFFFF).get();
+        final Checksum crc16 = Crc16.builder().setTable(Crc16.getModbusTable()).setInit(0xFFFF).get();
         stdUpdate(crc16);
         assertEquals(0x4B37, crc16.getValue());
         stdUpdate(crc16);
@@ -299,18 +299,18 @@ void testModbusCustom() {
     @ParameterizedTest
     @MethodSource
     void testModbusDefault(final String source, final long expected) {
-        testUpdateReset(source, expected, CRC16.modbus());
+        testUpdateReset(source, expected, Crc16.modbus());
     }
 
     @ParameterizedTest
     @MethodSource
     void testNrsc5Default(final String source, final long expected) {
-        testUpdateReset(source, expected, CRC16.nrsc5());
+        testUpdateReset(source, expected, Crc16.nrsc5());
     }
 
     @Test
     void testReset() {
-        final Checksum crc16 = CRC16.modbus();
+        final Checksum crc16 = Crc16.modbus();
         stdUpdate(crc16);
         assertEquals(0x4B37, crc16.getValue());
         stdUpdate(crc16);
@@ -322,7 +322,7 @@ void testReset() {
 
     @Test
     void testResetCustomModbus() {
-        final Checksum crc16 = CRC16.builder().setTable(CRC16.getModbusTable()).setInit(0x0000).get();
+        final Checksum crc16 = Crc16.builder().setTable(Crc16.getModbusTable()).setInit(0x0000).get();
         stdUpdate(crc16);
         assertEquals(0xBB3D, crc16.getValue());
         stdUpdate(crc16);
@@ -334,14 +334,14 @@ void testResetCustomModbus() {
 
     @Test
     void testUpdateArray() {
-        final Checksum crc16 = CRC16.builder().setTable(CRC16.getModbusTable()).setInit(0x0000).get();
+        final Checksum crc16 = Crc16.builder().setTable(Crc16.getModbusTable()).setInit(0x0000).get();
         stdUpdate(crc16);
         assertEquals(0xBB3D, crc16.getValue());
     }
 
     @Test
     void testUpdateInt() {
-        final Checksum crc16 = CRC16.builder().setTable(CRC16.getModbusTable()).setInit(0x0000).get();
+        final Checksum crc16 = Crc16.builder().setTable(Crc16.getModbusTable()).setInit(0x0000).get();
         final byte[] bytes = TEST_BYTES;
         for (final byte element : bytes) {
             crc16.update(element);
@@ -363,7 +363,7 @@ void testUpdateReset(final String source, final long expected, final Checksum cr
     @ParameterizedTest
     @MethodSource
     void testUsbDefault(final String source, final long expected) {
-        testUpdateReset(source, expected, CRC16.usb());
+        testUpdateReset(source, expected, Crc16.usb());
     }
 
 }