Example usage:
- *
- * {@code
+ * {@code
* boolean result1 = BoolUtil.and(true, true, false); // false
* boolean result2 = BoolUtil.or(true, false, false); // true
* boolean result3 = BoolUtil.not(false); // true
- * }
- *
+ * }
*
* @author zihluwang
- * @version 1.6.2
- * @since 1.6.2
+ * @version 3.0.0
*/
public final class BoolUtil {
+ /**
+ * Private constructor to prevent instantiation of this utility class.
+ */
+ private BoolUtil() {
+ }
+
/**
* Logical and calculation.
*
@@ -91,10 +99,4 @@ public final class BoolUtil {
.filter(Objects::nonNull)
.anyMatch(BooleanSupplier::getAsBoolean);
}
-
- /**
- * Private constructor to prevent instantiation of this utility class.
- */
- private BoolUtil() {}
-
}
diff --git a/common-toolbox/src/main/java/com/onixbyte/common/util/BranchUtil.java b/common-toolbox/src/main/java/com/onixbyte/common/util/BranchUtil.java
index a2c9ca8..c3e5dc1 100644
--- a/common-toolbox/src/main/java/com/onixbyte/common/util/BranchUtil.java
+++ b/common-toolbox/src/main/java/com/onixbyte/common/util/BranchUtil.java
@@ -1,18 +1,23 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.common.util;
@@ -64,11 +69,10 @@ import java.util.function.Supplier;
* expressions.
*
* @author zihluwang
- * @version 2.1.3
+ * @version 3.0.0
* @see java.util.function.Supplier
* @see java.util.function.BooleanSupplier
* @see java.lang.Runnable
- * @since 1.0.0
*/
public final class BranchUtil {
@@ -167,7 +171,8 @@ public final class BranchUtil {
*
* @param Example usage:
- *
- * {@code
+ * {@code
+ * // User.java
* public class User {
* private String name;
* private int age;
*
* // getters and setters
* }
- *
+ *
+ * // UserMapAdapter.java
* public class UserMapAdapter implements ObjectMapAdapter {
* @Override
* public Map toMap(User user) {
@@ -73,15 +79,19 @@ import java.util.Map;
* System.out.println(newUser.getAge()); // Output: 30
* }
* }
- * }
- *
+ * }
*
* @author zihluwang
- * @version 1.7.0
- * @since 1.0.0
+ * @version 3.0.0
*/
public final class MapUtil {
+ /**
+ * Private constructor to prevent instantiation of this utility class.
+ */
+ private MapUtil() {
+ }
+
/**
* Converts an object to a map by mapping the field names to their corresponding values.
*
@@ -106,10 +116,4 @@ public final class MapUtil {
public static Example usage:
- *
- * {@code
+ * {@code
* public class User {
* private String name;
* private int age;
@@ -54,13 +58,11 @@ import java.util.Map;
* return user;
* }
* }
- * }
- *
+ * }
*
* @param * If {@code start} is less than {@code end}, an ascending range (exclusive of {@code end}) - * is generated. If {@code start} is greater than {@code end}, a descending range (exclusive of {@code end}) - * is generated. If {@code start} equals {@code end}, an empty stream is returned. + * is generated. If {@code start} is greater than {@code end}, a descending range (exclusive + * of {@code end}) is generated. If {@code start} equals {@code end}, an empty stream + * is returned. *
* Example Usage: *
{@code
@@ -103,7 +110,8 @@ public final class RangeUtil {
*
* @param start the starting value of the range (inclusive)
* @param end upper-bound of the range (exclusive)
- * @return an {@code IntStream} of integers in ascending or descending order, exclusive of {@code end}
+ * @return an {@code IntStream} of integers in ascending or descending order, exclusive
+ * of {@code end}
* @see IntStream
*/
public static IntStream range(int start, int end) {
@@ -150,8 +158,8 @@ public final class RangeUtil {
}
/**
- * Generates a stream of integers starting from the specified {@code start} value, incremented by
- * the specified {@code step}, up to the specified {@code end} value.
+ * Generates a stream of integers starting from the specified {@code start} value, incremented
+ * by the specified {@code step}, up to the specified {@code end} value.
*
* It creates a sequential, ordered {@code IntStream} that can be used for iteration or
* further processing.
@@ -180,9 +188,10 @@ public final class RangeUtil {
* @param start the starting value of the range (inclusive)
* @param end upper-bound of the range (exclusive)
* @param step the increment or decrement between each value (non-zero)
- * @return an {@code IntStream} of integers from {@code start} to {@code end} exclusive stepping by {@code step}
- * @throws IllegalArgumentException if {@code step} is zero or if {@code start} and {@code end} are inconsistent
- * with the direction imposed by {@code step}
+ * @return an {@code IntStream} of integers from {@code start} to {@code end} exclusive stepping
+ * by {@code step}
+ * @throws IllegalArgumentException if {@code step} is zero or if {@code start} and {@code end}
+ * are inconsistent with the direction imposed by {@code step}
* @see IntStream
*/
public static IntStream range(int start, int end, int step) {
diff --git a/common-toolbox/src/main/resources/logback.xml b/common-toolbox/src/main/resources/logback.xml
index 56cd5b7..288ac4a 100644
--- a/common-toolbox/src/main/resources/logback.xml
+++ b/common-toolbox/src/main/resources/logback.xml
@@ -1,19 +1,24 @@
@@ -22,7 +27,7 @@
${COLOURFUL_OUTPUT}
@@ -31,4 +36,4 @@
-
\ No newline at end of file
+
diff --git a/crypto-toolbox/build.gradle.kts b/crypto-toolbox/build.gradle.kts
index e980f8d..81139e1 100644
--- a/crypto-toolbox/build.gradle.kts
+++ b/crypto-toolbox/build.gradle.kts
@@ -1,19 +1,25 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
+
import java.net.URI
plugins {
@@ -87,8 +93,8 @@ publishing {
}
scm {
- connection = "scm:git:git://github.com:OnixByte/JDevKit.git"
- developerConnection = "scm:git:git://github.com:OnixByte/JDevKit.git"
+ connection = "scm:git:git://github.com:onixbyte/onixbyte-toolbox.git"
+ developerConnection = "scm:git:git://github.com:onixbyte/onixbyte-toolbox.git"
url = projectGithubUrl
}
@@ -127,4 +133,4 @@ publishing {
}
}
}
-}
\ No newline at end of file
+}
diff --git a/crypto-toolbox/src/main/java/com/onixbyte/crypto/PrivateKeyLoader.java b/crypto-toolbox/src/main/java/com/onixbyte/crypto/PrivateKeyLoader.java
index 228e3cd..e1b7876 100644
--- a/crypto-toolbox/src/main/java/com/onixbyte/crypto/PrivateKeyLoader.java
+++ b/crypto-toolbox/src/main/java/com/onixbyte/crypto/PrivateKeyLoader.java
@@ -1,18 +1,23 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.crypto;
@@ -25,8 +30,7 @@ import java.security.PrivateKey;
*
* @author zihluwang
* @author siujamo
- * @version 2.0.0
- * @since 1.6.0
+ * @version 3.0.0
*/
public interface PrivateKeyLoader {
diff --git a/crypto-toolbox/src/main/java/com/onixbyte/crypto/PublicKeyLoader.java b/crypto-toolbox/src/main/java/com/onixbyte/crypto/PublicKeyLoader.java
index ecfb3e3..e4dff60 100644
--- a/crypto-toolbox/src/main/java/com/onixbyte/crypto/PublicKeyLoader.java
+++ b/crypto-toolbox/src/main/java/com/onixbyte/crypto/PublicKeyLoader.java
@@ -1,18 +1,23 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.crypto;
diff --git a/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/ecdsa/ECPrivateKeyLoader.java b/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/ecdsa/ECPrivateKeyLoader.java
index 672c65f..fa527ec 100644
--- a/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/ecdsa/ECPrivateKeyLoader.java
+++ b/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/ecdsa/ECPrivateKeyLoader.java
@@ -1,18 +1,23 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.crypto.algorithm.ecdsa;
@@ -35,26 +40,18 @@ import java.util.Set;
/**
* Key pair loader for loading key pairs for ECDSA-based algorithms.
*
- *
- * Example usage for ECDSA:
+ * Example usage:
*
{@code
- * PrivateKeyLoader keyLoader = new EcKeyLoader();
+ * PrivateKeyLoader keyLoader = new ECPrivateKeyLoader();
* String pemPrivateKey = """
* -----BEGIN EC PRIVATE KEY-----
* ...
* -----END EC PRIVATE KEY-----""";
* ECPrivateKey privateKey = PrivateKeyLoader.loadEcdsaPrivateKey(pemPrivateKey);
- *
- * String pemPublicKey = """
- * -----BEGIN EC PUBLIC KEY-----
- * ...
- * -----END EC PUBLIC KEY-----""";
- * ECPublicKey publicKey = PrivateKeyLoader.loadPublicKey(pemPublicKey);
* }
*
* @author zihluwang
- * @version 2.0.0
- * @since 2.0.0
+ * @version 3.0.0
*/
public class ECPrivateKeyLoader implements PrivateKeyLoader {
diff --git a/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/ecdsa/ECPublicKeyLoader.java b/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/ecdsa/ECPublicKeyLoader.java
index a31f98a..de14870 100644
--- a/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/ecdsa/ECPublicKeyLoader.java
+++ b/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/ecdsa/ECPublicKeyLoader.java
@@ -1,18 +1,23 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.crypto.algorithm.ecdsa;
@@ -32,6 +37,9 @@ import java.util.Base64;
import java.util.HashSet;
import java.util.Set;
+/**
+ *
+ */
public class ECPublicKeyLoader implements PublicKeyLoader {
/**
diff --git a/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/rsa/RSAPrivateKeyLoader.java b/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/rsa/RSAPrivateKeyLoader.java
index 1f8c357..8cd6eb9 100644
--- a/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/rsa/RSAPrivateKeyLoader.java
+++ b/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/rsa/RSAPrivateKeyLoader.java
@@ -1,18 +1,23 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.crypto.algorithm.rsa;
@@ -32,14 +37,15 @@ import java.util.Base64;
/**
* A class responsible for loading RSA keys from PEM formatted text.
*
- * This class implements the {@link PrivateKeyLoader} interface and provides methods to load both private
- * and public RSA keys. The keys are expected to be in the standard PEM format, which includes
- * Base64-encoded key content surrounded by header and footer lines. The class handles the decoding
- * of Base64 content and the generation of keys using the RSA key factory.
+ * This class implements the {@link PrivateKeyLoader} interface and provides methods to load both
+ * private and public RSA keys. The keys are expected to be in the standard PEM format, which
+ * includes Base64-encoded key content surrounded by header and footer lines. The class handles
+ * the decoding of Base64 content and the generation of keys using the RSA key factory.
*
* Any exceptions encountered during the loading process are encapsulated in a
* {@link KeyLoadingException}, allowing for flexible error handling.
*
+ * @author zihluwang
* @author siujamo
* @see PrivateKeyLoader
* @see KeyLoadingException
diff --git a/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/rsa/RSAPublicKeyLoader.java b/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/rsa/RSAPublicKeyLoader.java
index 2e14518..f1a5c7b 100644
--- a/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/rsa/RSAPublicKeyLoader.java
+++ b/crypto-toolbox/src/main/java/com/onixbyte/crypto/algorithm/rsa/RSAPublicKeyLoader.java
@@ -1,18 +1,23 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.crypto.algorithm.rsa;
@@ -31,6 +36,9 @@ import java.security.spec.RSAPublicKeySpec;
import java.security.spec.X509EncodedKeySpec;
import java.util.Base64;
+/**
+ *
+ */
public class RSAPublicKeyLoader implements PublicKeyLoader {
private final Base64.Decoder decoder;
diff --git a/crypto-toolbox/src/main/java/com/onixbyte/crypto/exception/KeyLoadingException.java b/crypto-toolbox/src/main/java/com/onixbyte/crypto/exception/KeyLoadingException.java
index 9ae5b7f..648182c 100644
--- a/crypto-toolbox/src/main/java/com/onixbyte/crypto/exception/KeyLoadingException.java
+++ b/crypto-toolbox/src/main/java/com/onixbyte/crypto/exception/KeyLoadingException.java
@@ -1,18 +1,23 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.crypto.exception;
@@ -39,7 +44,6 @@ package com.onixbyte.crypto.exception;
*
* @author zihluwang
* @version 3.0.0
- * @since 1.6.0
*/
public class KeyLoadingException extends RuntimeException {
diff --git a/crypto-toolbox/src/main/java/com/onixbyte/crypto/util/CryptoUtil.java b/crypto-toolbox/src/main/java/com/onixbyte/crypto/util/CryptoUtil.java
index 3cb66d0..9432a27 100644
--- a/crypto-toolbox/src/main/java/com/onixbyte/crypto/util/CryptoUtil.java
+++ b/crypto-toolbox/src/main/java/com/onixbyte/crypto/util/CryptoUtil.java
@@ -1,24 +1,35 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.crypto.util;
+/**
+ *
+ */
public final class CryptoUtil {
+ /**
+ * Private constructor to prevent instantiation of this utility class.
+ */
private CryptoUtil() {
}
diff --git a/crypto-toolbox/src/main/resources/logback.xml b/crypto-toolbox/src/main/resources/logback.xml
index 1cf5a50..288ac4a 100644
--- a/crypto-toolbox/src/main/resources/logback.xml
+++ b/crypto-toolbox/src/main/resources/logback.xml
@@ -1,26 +1,33 @@
-
${COLOURFUL_OUTPUT}
@@ -29,4 +36,4 @@
-
\ No newline at end of file
+
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
index d64cd49..e69de29 100644
Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/gradlew b/gradlew
index 1aa94a4..447618b 100755
--- a/gradlew
+++ b/gradlew
@@ -1,19 +1,25 @@
#!/bin/sh
#
-# Copyright © 2015-2021 the original authors.
+# Copyright (c) 2024-2025 OnixByte
#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
#
-# https://www.apache.org/licenses/LICENSE-2.0
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
#
##############################################################################
diff --git a/identity-generator/build.gradle.kts b/identity-generator/build.gradle.kts
index 8821412..d3c7471 100644
--- a/identity-generator/build.gradle.kts
+++ b/identity-generator/build.gradle.kts
@@ -1,19 +1,25 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
+
import java.net.URI
plugins {
diff --git a/identity-generator/src/main/java/com/onixbyte/identitygenerator/IdentityGenerator.java b/identity-generator/src/main/java/com/onixbyte/identitygenerator/IdentityGenerator.java
index 823d85b..2232c43 100644
--- a/identity-generator/src/main/java/com/onixbyte/identitygenerator/IdentityGenerator.java
+++ b/identity-generator/src/main/java/com/onixbyte/identitygenerator/IdentityGenerator.java
@@ -1,25 +1,30 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.identitygenerator;
/**
- * The {@code IdentityGenerator} is a generic interface for generating globally unique identifiers (GUIDs)
- * of a specific type.
+ * The {@code IdentityGenerator} is a generic interface for generating globally unique identifiers
+ * (GUIDs) of a specific type.
*
* The type of ID is determined by the class implementing this interface.
*
@@ -45,9 +50,8 @@ package com.onixbyte.identitygenerator;
* }
*
* @param - * This implementation utilises a cryptographically strong {@link SecureRandom} instance to produce the random - * component of the UUID. The first 6 bytes of the UUID encode the current timestamp in milliseconds, ensuring that - * generated UUIDs are roughly ordered by creation time. + * This implementation utilises a cryptographically strong {@link SecureRandom} instance to produce + * the random component of the UUID. The first 6 bytes of the UUID encode the current timestamp in + * milliseconds, ensuring that generated UUIDs are roughly ordered by creation time. *
- * The generated UUID adheres strictly to the layout and variant bits of UUID version 7 as defined in the specification. - *
+ * The generated UUID adheres strictly to the layout and variant bits of UUID version 7 as defined + * in the specification. + * + * @author zihluwang + * @author siujamo + * @version 3.0.0 */ public class SequentialUuidGenerator implements IdentityGenerator
- * When initializing a {@link SnowflakeIdentityGenerator}, you must provide the worker ID and data centre
- * ID, ensuring they are within the valid range defined by the bit size. The generator maintains an
- * internal sequence number that increments for IDs generated within the same millisecond. If the
- * system clock moves backward, an exception is thrown to prevent generating IDs with
- * repeated timestamps.
+ * When initializing a {@link SnowflakeIdentityGenerator}, you must provide the worker ID and data
+ * centre ID, ensuring they are within the valid range defined by the bit size. The generator
+ * maintains an internal sequence number that increments for IDs generated within the
+ * same millisecond. If the system clock moves backward, an exception is thrown to prevent
+ * generating IDs with repeated timestamps.
*
- * @author Zihlu Wang
- * @version 1.1.0
- * @since 1.0.0
+ * @author zihluwang
+ * @version 3.0.0
*/
public final class SnowflakeIdentityGenerator implements IdentityGenerator
- * Usage:
- * To use the {@code AuthzeroTokenResolver}, first, create an instance of this class:
- *
- * Then, you can utilize the various methods provided by this resolver to handle JWT tokens:
- *
- * Note:
- * It is essential to configure the appropriate algorithms, secret, and issuer according to your
- * specific use case when using this resolver. Additionally, ensure that the
- * {@code com.auth0:java-jwt} library is correctly configured in your project's dependencies.
- *
- * @author Zihlu Wang
- * @version 1.1.1
- * @see IdentityGenerator
- * @see Algorithm
- * @see JWTVerifier
- * @see JWTCreator
- * @see JWTCreator.Builder
- * @since 1.0.0
- */
-public class AuthzeroTokenResolver implements TokenResolver
- * A secret required by HMAC-based algorithms, or key pair required by ECDSA-based
- * algorithms need to be set before initialise an algorithm.
- *
- * @param algorithm an {@link TokenAlgorithm} value
- * @return the builder instance
- */
- public Builder algorithm(TokenAlgorithm algorithm) {
- // check the secret or key pair before algorithm initialised
- if (HMAC_ALGORITHMS.containsKey(algorithm)) {
- if (Objects.isNull(secret) || secret.isBlank()) {
- throw new IllegalSecretException("""
- Please specify a secret before define an algorithm.""");
- }
- } else if (ECDSA_ALGORITHMS.containsKey(algorithm)) {
- if (Objects.isNull(publicKey) || Objects.isNull(privateKey)) {
- throw new IllegalKeyPairException("""
- Please specify a ECDSA key pair before define an algorithm.""");
- }
- }
-
- // initialise algorithm
- this.algorithm = switch (algorithm) {
- case HS256, HS384, HS512 -> HMAC_ALGORITHMS.get(algorithm).apply(secret);
- case ES256, ES384, ES512 -> ECDSA_ALGORITHMS.get(algorithm)
- .apply(publicKey, privateKey);
- default -> throw new UnsupportedAlgorithmException("""
- This algorithm is not supported yet.""");
- };
- return this;
- }
-
- /**
- * Set the object mapper.
- *
- * @param objectMapper an object mapper
- * @return the builder instance
- */
- public Builder objectMapper(ObjectMapper objectMapper) {
- this.objectMapper = objectMapper;
- return this;
- }
-
- /**
- * Set the creator of JWT id.
- *
- * @param jtiCreator a creator to create JWT id
- * @return the builder instance
- */
- public Builder jtiCreator(IdentityGenerator jtiCreator) {
- this.jtiCreator = jtiCreator;
- return this;
- }
-
- /**
- * Set the issuer of created JWT.
- *
- * @param issuer the person or organisation issued this JWT
- * @return the builder instance
- */
- public Builder issuer(String issuer) {
- this.issuer = issuer;
- return this;
- }
-
- /**
- * Create an {@link AuthzeroTokenResolver} instance
- *
- * @return created instance
- */
- public AuthzeroTokenResolver build() {
- return new AuthzeroTokenResolver(jtiCreator, algorithm, issuer, objectMapper);
- }
- }
-
- /**
- * Creates a new token with the specified expiration duration, subject, and
- * audience.
- *
- * @param expireAfter the duration after which the token will expire
- * @param subject the subject of the token
- * @param audience the audience for which the token is intended
- * @return the generated token as a {@code String}
- */
- @Override
- public String createToken(Duration expireAfter, String audience, String subject) {
- final var builder = JWT.create();
- buildBasicInfo(builder, expireAfter, subject, audience);
- return buildToken(builder);
- }
-
- /**
- * Creates a new token with the specified expiration time, subject,
- * audience, and custom payload data.
- *
- * @param expireAfter the duration after which the token will expire
- * @param subject the subject of the token
- * @param audience the audience for which the token is intended
- * @param payloads the custom payload data to be included in the token
- * @return the generated token as a {@code String}
- */
- @Override
- public String createToken(Duration expireAfter, String audience, String subject, Map
- * This method is used to add custom claims to the JWT. It takes a Map of
- * claims, where each entry represents a custom claim name (key) and its
- * corresponding value (value). The custom claims will be added to the JWT
- * using the JWTCreator.Builder.
- *
- * @param claims a Map containing the custom claims to be added to the JWT
- * @param builder the JWTCreator.Builder instance to which the custom
- * claims will be added
- */
- private void buildMapClaims(JWTCreator.Builder builder, Map
- * This is the final step of create a token, to sign this token.
- *
- * @param builder the builder to build this JWT
- * @return the generated token as a {@code String}
- */
- private String buildToken(JWTCreator.Builder builder) {
- return builder.sign(algorithm);
- }
-
- /**
- * Default type reference for Map.
- */
- public static class MapTypeReference extends TypeReference
- * Implementing this interface indicates that the data class contains
- * information that needs to be securely transmitted and verified as part of a
- * JWT. The payload typically contains claims or attributes that provide
- * additional information about the JWT subject or context.
- *
- * Usage:
- * To use a class as a JWT payload, simply implement the {@code TokenPayload}
- * interface in the data class:
- *
- * Token Creation:
- * The interface provides overloaded methods for creating tokens with different
- * payload configurations, including expiration time, audience, subject, and
- * custom payload data. Clients can choose the appropriate method based on
- * their specific token requirements.
- *
- * Token Extraction:
- * The interface includes methods to extract payload information from a given
- * token. Clients can use these methods to obtain the payload data encoded in
- * the token.
- *
- * Token Renewal:
- * The interface also offers methods for token renewal. Clients can renew an
- * expired token by providing a new expiration time, audience, subject, and
- * optional custom payload data.
- *
- * @param
- * Usage:
- * To exclude a property from the JWT payload, annotate the property with
- * {@code @ExcludeFromPayload}:
- *
- *
- * Note:
- * This annotation should be used on properties that are not intended to
- * be included in the JWT payload due to their sensitive nature or for other
- * reasons only. It is important to carefully choose which properties are
- * excluded from the payload to ensure the JWT remains secure and efficient.
- *
- * @author Zihlu Wang
- * @version 1.1.0
- * @since 1.0.0
- */
-@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.FIELD})
-public @interface ExcludeFromPayload {
-}
diff --git a/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/annotations/TokenEnum.java b/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/annotations/TokenEnum.java
deleted file mode 100644
index e2f626b..0000000
--- a/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/annotations/TokenEnum.java
+++ /dev/null
@@ -1,51 +0,0 @@
-/*
- * Copyright (C) 2024-2025 OnixByte.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.onixbyte.jwt.annotations;
-
-import com.onixbyte.jwt.constants.TokenDataType;
-
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
-
-/**
- * This annotation marks the enum field declared in payload class will be handled as basic data
- * types in {@link TokenDataType}.
- *
- * @author Zihlu Wang
- */
-@Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.FIELD})
-public @interface TokenEnum {
-
- /**
- * The name of the field of the base data corresponding to the enumeration data.
- *
- * @return the name of the property
- */
- String propertyName();
-
- /**
- * The attribute {@code dataType} specifies what base data type to treat this enum as.
- *
- * @return the data type of the token
- */
- TokenDataType dataType();
-
-}
diff --git a/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/constants/PredefinedKeys.java b/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/constants/PredefinedKeys.java
index 36de075..d8f4a12 100644
--- a/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/constants/PredefinedKeys.java
+++ b/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/constants/PredefinedKeys.java
@@ -1,18 +1,23 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.jwt.constants;
@@ -26,13 +31,13 @@ import java.util.List;
*
* The class provides the following standard JWT claim constants:
*
* The class also contains a list of all the standard claim constants, accessible via the {@link
@@ -43,7 +48,7 @@ import java.util.List;
* the standard JWT claim constants.
*
* @author zihluwang
- * @version 1.1.0
+ * @version 3.0.0
* @since 1.0.0
*/
public final class PredefinedKeys {
@@ -86,8 +91,15 @@ public final class PredefinedKeys {
/**
* List containing all the standard JWT claim constants.
*/
- public static final List
* Supported Algorithms:
*
* If you want the supports to an unsupported algorithm, you could
*
- * {@code WeakSecretException} will only appears that if you are using the
- * implementation module {@code cn.org.codecrafters:simple-jwt-jjwt} due to
- * it is implemented by {@code io.jsonwebtoken:jjwt}.
+ * {@code WeakSecretException} will only appears that if you are using the implementation module
+ * {@code com.onixbyte:jwt-toolbox-auth0} due to it is implemented by {@code com.auth0:java-jwt}.
*
- * @author Zihlu Wang
- * @version 1.1.0
+ * @author zihluwang
+ * @version 3.0.0
* @since 1.0.0
*/
public class WeakSecretException extends RuntimeException {
/**
- * Constructs a new {@code WeakSecretException} with {@code null} as its
- * detail message. The cause is not initialized, and may subsequently be
- * initialized by a call to {@link #initCause}.
+ * Constructs a new {@code WeakSecretException} with {@code null} as its detail message.
+ * The cause is not initialized, and may subsequently be initialized by a call
+ * to {@link #initCause}.
*/
public WeakSecretException() {
}
/**
- * Constructs a new {@code WeakSecretException} with the specified detail
- * message. The cause is not initialized, and may subsequently be
- * initialized by a call to {@link #initCause}.
+ * Constructs a new {@code WeakSecretException} with the specified detail message. The cause is
+ * not initialised, and may subsequently be initialized by a call to {@link #initCause}.
*
- * @param message the detail message. The detail message is saved for
- * later retrieval by the {@link #getMessage()} method.
+ * @param message the detail message. The detail message is saved for later retrieval by the
+ * {@link #getMessage()} method.
*/
public WeakSecretException(String message) {
super(message);
}
/**
- * Constructs a new {@code WeakSecretException} with the specified detail
- * message and cause.
+ * Constructs a new {@code WeakSecretException} with the specified detail message and cause.
*
- * Note that the detail message associated with {@code cause} is not
- * automatically incorporated in this runtime exception's detail message.
+ * Note that the detail message associated with {@code cause} is not automatically
+ * incorporated in this runtime exception's detail message.
*
- * @param message the detail message (which is saved for later retrieval
- * by the {@link #getMessage()} method).
+ * @param message the detail message (which is saved for later retrieval by the
+ * {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A {@code null} value is
- * permitted, and indicates that the cause is nonexistent or
- * unknown.)
+ * {@link #getCause()} method). (A {@code null} value is permitted, and
+ * indicates that the cause is nonexistent or unknown.)
* @since 1.0.0
*/
public WeakSecretException(String message, Throwable cause) {
@@ -71,16 +71,14 @@ public class WeakSecretException extends RuntimeException {
}
/**
- * Constructs a new {@code WeakSecretException} with the specified cause
- * and a detail message of {@code (cause==null ? null : cause.toString())}
- * (which typically contains the class and detail message of
- * {@code cause}). This constructor is useful for runtime exceptions that
- * are little more than wrappers for other throwable.
+ * Constructs a new {@code WeakSecretException} with the specified cause and a detail message
+ * of {@code (cause==null ? null : cause.toString())} (which typically contains the class and
+ * detail message of {@code cause}). This constructor is useful for runtime exceptions that are
+ * little more than wrappers for other throwable.
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A {@code null} value is
- * permitted, and indicates that the cause is nonexistent or
- * unknown.)
+ * {@link #getCause()} method). (A {@code null} value is permitted, and indicates
+ * that the cause is nonexistent or unknown.)
* @since 1.0.0
*/
public WeakSecretException(Throwable cause) {
@@ -88,19 +86,22 @@ public class WeakSecretException extends RuntimeException {
}
/**
- * Constructs a new {@code WeakSecretException} with the specified detail
- * message, cause, suppression enabled or disabled, and writable
- * stack trace enabled or disabled.
+ * Constructs a new {@code WeakSecretException} with the specified detail message, cause,
+ * suppression enabled or disabled, and writable stack trace enabled or disabled.
*
* @param message the detail message.
- * @param cause the cause. (A {@code null} value is permitted,
- * and indicates that the cause is nonexistent or
- * unknown.)
+ * @param cause the cause. (A {@code null} value is permitted, and indicates that
+ * the cause is nonexistent or unknown.)
* @param enableSuppression whether suppression is enabled or disabled
* @param writableStackTrace whether the stack trace should be writable
* @since 1.0.0
*/
- public WeakSecretException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
+ public WeakSecretException(
+ String message,
+ Throwable cause,
+ boolean enableSuppression,
+ boolean writableStackTrace
+ ) {
super(message, cause, enableSuppression, writableStackTrace);
}
}
diff --git a/jwt-toolbox-facade/src/main/resources/logback.xml b/jwt-toolbox-facade/src/main/resources/logback.xml
index 6d26440..288ac4a 100644
--- a/jwt-toolbox-facade/src/main/resources/logback.xml
+++ b/jwt-toolbox-facade/src/main/resources/logback.xml
@@ -1,26 +1,33 @@
- * This autoconfiguration class sets up the necessary beans and components required for JWT
- * generation and validation. It automatically creates and configures the
- * {@link AuthzeroTokenResolver} bean based on the available options and properties.
- *
- * Developers using the Simple JWT library with Spring Boot do not need to explicitly configure the
- * library, as the autoconfiguration takes care of setting up the necessary components and
- * configurations automatically. However, developers still have the flexibility to customise the
- * behavior of the library by providing their own configurations and properties.
- *
- * @author zihluwang
- * @version 1.6.0
- * @since 1.0.0
- */
-@AutoConfiguration
-@EnableConfigurationProperties(value = {SimpleJwtProperties.class})
-@ConditionalOnClass({DecodedJWT.class, AuthzeroTokenResolver.class})
-@ConditionalOnMissingBean({TokenResolver.class})
-@ConditionalOnBean(value = {IdentityGenerator.class}, name = "jtiCreator")
-@AutoConfigureAfter(value = GuidAutoConfiguration.class)
-public class AuthzeroTokenResolverAutoConfiguration {
-
- private final static Logger log = LoggerFactory.getLogger(AuthzeroTokenResolverAutoConfiguration.class);
-
- /**
- * Constructs a new {@code SimpleJwtAutoConfiguration} instance with the
- * provided SimpleJwtProperties.
- *
- * @param simpleJwtProperties a {@link SimpleJwtProperties} instance
- * @param jtiCreator a creator to create ids for JSON Web Token
- * @param objectMapper jackson JSON Handler
- */
- @Autowired
- public AuthzeroTokenResolverAutoConfiguration(SimpleJwtProperties simpleJwtProperties,
- @Qualifier("jtiCreator") IdentityGenerator jtiCreator,
- ObjectMapper objectMapper) {
- this.jtiCreator = jtiCreator;
- this.simpleJwtProperties = simpleJwtProperties;
- this.objectMapper = objectMapper;
- }
-
- /**
- * Creates a new {@link TokenResolver} bean using {@link AuthzeroTokenResolver} if no existing
- * {@link TokenResolver} bean is found. The {@link AuthzeroTokenResolver} is configured with the
- * provided {@link IdentityGenerator}, {@code algorithm}, {@code issuer}, and {@code secret}
- * properties from {@link SimpleJwtProperties}.
- *
- * @return the {@link TokenResolver} instance
- */
- @Bean
- public TokenResolver
- * {@code SimpleJwtProperties} provides configuration options for the JWT algorithm, issuer,
- * and secret. The properties are used by the {@link AuthzeroTokenResolverAutoConfiguration} to
+ * {@code JwtProperties} provides configuration options for the JWT algorithm, issuer,
+ * and secret. The properties are used by the {@code Auth0AutoConfiguration} to
* set up the necessary configurations for JWT generation and validation.
*
* Developers can customise the JWT algorithm, issuer, and secret by setting the corresponding
- * properties in the application's properties file. The {@code SimpleJwtAutoConfiguration} class
+ * properties in the application's properties file. The {@code Auth0AutoConfiguration} class
* reads these properties and uses them to create the TokenResolver bean with the
* desired configuration.
*
@@ -41,13 +45,13 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
* @version 1.1.0
* @since 1.0.0
*/
-@ConfigurationProperties(prefix = "onixbyte.simple-jwt")
-public class SimpleJwtProperties {
+// @ConfigurationProperties(prefix = "onixbyte.jwt")
+public class JwtProperties {
/**
* Default constructor.
*/
- public SimpleJwtProperties() {
+ public JwtProperties() {
}
/**
diff --git a/jwt-toolbox-spring-boot-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/jwt-toolbox-spring-boot-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
index fbd0048..a164fa1 100644
--- a/jwt-toolbox-spring-boot-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
+++ b/jwt-toolbox-spring-boot-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
@@ -1,2 +1 @@
com.onixbyte.jwt.autoconfiguration.GuidAutoConfiguration
-com.onixbyte.jwt.autoconfiguration.AuthzeroTokenResolverAutoConfiguration
diff --git a/jwt-toolbox-spring-boot-starter/src/main/resources/logback.xml b/jwt-toolbox-spring-boot-starter/src/main/resources/logback.xml
index fd31eac..288ac4a 100644
--- a/jwt-toolbox-spring-boot-starter/src/main/resources/logback.xml
+++ b/jwt-toolbox-spring-boot-starter/src/main/resources/logback.xml
@@ -1,26 +1,33 @@
* This class contains static methods to:
*
* This class is final, meaning it cannot be subclassed, and it only contains static methods,
* so instances of the class cannot be created.
*
* Quartile bounds consist of:
*
* Example usage:
- * {@code
- * TokenResolver
- * {@code
- * // Creating a new JWT token
- * String token =
- * tokenResolver.createToken(Duration.ofHours(1),
- * "your_subject",
- * "your_audience",
- * customPayloads);
- *
- * // Extracting payload data from a JWT token
- * DecodedJWT decodedJWT = tokenResolver.resolve(token);
- * T payloadData = decodedJWT.extract(token, T.class);
- *
- * // Renewing an existing JWT token
- * String renewedToken =
- * tokenResolver.renew(token, Duration.ofMinutes(30), customPayloads);
- * }
- *
- * public class UserData implements TokenPayload {
- * // Class implementation with payload data...
- * }
- *
- *
- * @author Zihlu Wang
- * @version 1.1.0
- * @since 1.0.0
- */
-public interface TokenPayload {
-}
diff --git a/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/TokenResolver.java b/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/TokenResolver.java
deleted file mode 100644
index 09b6ab1..0000000
--- a/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/TokenResolver.java
+++ /dev/null
@@ -1,184 +0,0 @@
-/*
- * Copyright (C) 2024-2025 OnixByte.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.onixbyte.jwt;
-
-import java.time.Duration;
-import java.util.Map;
-
-/**
- * {@code TokenResolver} defines methods for creating, extracting, and
- * renewing tokens, particularly JSON Web Tokens (JWTs). It provides a set of
- * methods to generate tokens with various payload configurations, extract
- * payload from tokens, and renew expired tokens.
- * {@code
- * public class UserData implements TokenPayload {
- * private String username;
- *
- * // This property will not be included in the JWT payload
- * @ExcludeFromPayload
- * private String sensitiveData;
- *
- * // Getters and setters...
- * }
- * }
- *
- *
*
- *
*
- * @author Zihlu Wang
- * @version 1.1.0
+ * @author zihluwang
+ * @version 3.0.0
* @since 1.0.0
*/
public enum TokenAlgorithm {
@@ -91,18 +94,4 @@ public enum TokenAlgorithm {
ES512,
;
- /**
- * HMAC-based algorithms.
- */
- public static final List
@@ -30,42 +30,39 @@ import com.onixbyte.jwt.TokenResolver;
*
*
- * @author Zihlu Wang
- * @version 1.1.0
- * @since 1.0.0
+ * @author zihluwang
+ * @version 3.0.0
*/
public class UnsupportedAlgorithmException extends RuntimeException {
/**
- * Constructs a new {@code UnsupportedAlgorithmException} with {@code null}
- * as its detail message. The cause is not initialized, and may
- * subsequently be initialized by a call to {@link #initCause}.
+ * Constructs a new {@code UnsupportedAlgorithmException} with {@code null} as its
+ * detail message. The cause is not initialized, and may subsequently be initialized by a call
+ * to {@link #initCause}.
*/
public UnsupportedAlgorithmException() {
}
/**
- * Constructs a new {@code UnsupportedAlgorithmException} with the
- * specified detail message. The cause is not initialized, and may
- * subsequently be initialized by a call to {@link #initCause}.
+ * Constructs a new {@code UnsupportedAlgorithmException} with the specified detail message.
+ * The cause is not initialized, and may subsequently be initialized by a call
+ * to {@link #initCause}.
*
- * @param message the detail message. The detail message is saved for
- * later retrieval by the {@link #getMessage()} method.
+ * @param message the detail message. The detail message is saved for later retrieval by the {@link #getMessage()} method.
*/
public UnsupportedAlgorithmException(String message) {
super(message);
}
/**
- * Constructs a new {@code UnsupportedAlgorithmException} with the
- * specified detail message and cause.
+ * Constructs a new {@code UnsupportedAlgorithmException} with the specified detail message
+ * and cause.
*
- * @param message the detail message (which is saved for later retrieval
- * by the {@link #getMessage()} method).
+ * @param message the detail message (which is saved for later retrieval by the
+ * {@link #getMessage()} method)
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A {@code null} value is
- * permitted, and indicates that the cause is nonexistent or
- * unknown.)
+ * {@link #getCause()} method). (A {@code null} value is permitted, and
+ * indicates that the cause is nonexistent or unknown.)
* @since 1.4
*/
public UnsupportedAlgorithmException(String message, Throwable cause) {
@@ -73,17 +70,14 @@ public class UnsupportedAlgorithmException extends RuntimeException {
}
/**
- * Constructs a new {@code UnsupportedAlgorithmException} with the
- * specified cause and a detail message of
- * {@code (cause==null ? null : cause.toString())} (which typically
- * contains the class and detail message of {@code cause}). This
- * constructor is useful for runtime exceptions that are little more
- * than wrappers for other throwable.
+ * Constructs a new {@code UnsupportedAlgorithmException} with the specified cause and a detail
+ * message of {@code (cause==null ? null : cause.toString())} (which typically contains the
+ * class and detail message of {@code cause}). This constructor is useful for runtime
+ * exceptions that are little more than wrappers for other throwable.
*
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A {@code null} value is
- * permitted, and indicates that the cause is nonexistent or
- * unknown.)
+ * {@link #getCause()} method). (A {@code null} value is permitted, and indicates
+ * that the cause is nonexistent or unknown.)
* @since 1.4
*/
public UnsupportedAlgorithmException(Throwable cause) {
@@ -91,19 +85,22 @@ public class UnsupportedAlgorithmException extends RuntimeException {
}
/**
- * Constructs a new {@code UnsupportedAlgorithmException} with the
- * specified detail message, cause, suppression enabled or disabled, and
- * writable stack trace enabled or disabled.
+ * Constructs a new {@code UnsupportedAlgorithmException} with the specified detail message,
+ * cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
*
* @param message the detail message.
- * @param cause the cause (A {@code null} value is permitted,
- * and indicates that the cause is nonexistent or
- * unknown.)
+ * @param cause the cause (A {@code null} value is permitted, and indicates that
+ * the cause is nonexistent or unknown.)
* @param enableSuppression whether suppression is enabled or disabled
* @param writableStackTrace whether the stack trace should be writable
* @since 1.0.0
*/
- public UnsupportedAlgorithmException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
+ public UnsupportedAlgorithmException(
+ String message,
+ Throwable cause,
+ boolean enableSuppression,
+ boolean writableStackTrace
+ ) {
super(message, cause, enableSuppression, writableStackTrace);
}
}
diff --git a/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/exceptions/WeakSecretException.java b/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/exceptions/WeakSecretException.java
index 7c81641..1ee17e1 100644
--- a/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/exceptions/WeakSecretException.java
+++ b/jwt-toolbox-facade/src/main/java/com/onixbyte/jwt/exceptions/WeakSecretException.java
@@ -1,69 +1,69 @@
/*
- * Copyright (C) 2024-2025 OnixByte.
+ * Copyright (c) 2024-2025 OnixByte
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
package com.onixbyte.jwt.exceptions;
/**
- * {@code WeakSecretException} represents that your secret is too weak to be
- * used in signing JWTs.
+ * {@code WeakSecretException} represents that your secret is too weak to be used in signing JWTs.
*
- *
* Example usage:
- *
- * {@code
+ *
*
* @author zihluwang
- * @version 1.6.5
+ * @version 3.0.0
* @since 1.6.5
*/
public final class PercentileCalculator {
- private final static Logger log = LoggerFactory.getLogger(PercentileCalculator.class);
-
/**
* Private constructor to prevent instantiation of this utility class.
*/
@@ -100,18 +103,18 @@ public final class PercentileCalculator {
*/
public static QuartileBounds calculatePercentileBounds(List{@code
* List
+ * }
- *
*
+ *
*
* @param upperBound the upper bound of the dataset
* @param lowerBound the lower bound of the dataset
* @author zihluwang
- * @version 1.6.5
+ * @version 3.0.0
* @since 1.6.5
*/
public record QuartileBounds(
- Double upperBound,
- Double lowerBound
+ Double upperBound,
+ Double lowerBound
) {
/**
diff --git a/math-toolbox/src/main/resources/logback.xml b/math-toolbox/src/main/resources/logback.xml
index 1cf5a50..288ac4a 100644
--- a/math-toolbox/src/main/resources/logback.xml
+++ b/math-toolbox/src/main/resources/logback.xml
@@ -1,26 +1,33 @@
{@code
* QuartileBounds bounds = QuartileBounds.builder()
- * .lowerBound(1.5)
- * .upperBound(7.5)
- * .build();
- *
+ * .lowerBound(1.5)
+ * .upperBound(7.5)
+ * .build();
+ * }