diff --git a/README.md b/README.md index e03f953..603bca4 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ A module for generating globally unique IDs. It includes a facade interface and _[Learn more](https://github.com/CodeCraftersCN/jdevkit/webcal/README.md)_ -The module `webcal` is a Java library that facilitates the generation and resolution of iCalendar content for web-based calendar applications. It provides a flexible and easy-to-use API for creating web calendars with customizable settings and events. +The module `webcal` is a Java library that facilitates the generation and resolution of iCalendar content for web-based calendar applications. It provides a flexible and easy-to-use API for creating web calendars with customisable settings and events. With the `webcal` module, developers can easily integrate calendar functionality into web applications, enabling users to view, add, and manage events in a structured and standardized format. It is designed to simplify calendar-related tasks and enhance the overall user experience when dealing with calendar data on the web. diff --git a/devkit-utils/src/main/java/cn/org/codecrafters/devkit/utils/ChainedCalcUtil.java b/devkit-utils/src/main/java/cn/org/codecrafters/devkit/utils/ChainedCalcUtil.java index 98d69bf..21a9273 100644 --- a/devkit-utils/src/main/java/cn/org/codecrafters/devkit/utils/ChainedCalcUtil.java +++ b/devkit-utils/src/main/java/cn/org/codecrafters/devkit/utils/ChainedCalcUtil.java @@ -31,7 +31,7 @@ import java.util.function.Function; * The ChainedCalcUtil class provides a convenient way to perform chained * high-precision calculations using BigDecimal. It allows users to perform * mathematical operations such as addition, subtraction, multiplication, - * and division with customizable precision and scale. By using this utility + * and division with customisable precision and scale. By using this utility * class, developers can achieve accurate results and avoid precision loss * in their calculations. *

diff --git a/guid/src/main/java/cn/org/codecrafters/guid/SnowflakeGuidCreator.java b/guid/src/main/java/cn/org/codecrafters/guid/SnowflakeGuidCreator.java index 9600b51..582bd2e 100644 --- a/guid/src/main/java/cn/org/codecrafters/guid/SnowflakeGuidCreator.java +++ b/guid/src/main/java/cn/org/codecrafters/guid/SnowflakeGuidCreator.java @@ -26,19 +26,19 @@ import java.time.ZoneOffset; * SnowflakeGuidCreator - GUID generator based on the Snowflake algorithm. *

* The SnowflakeGuidCreator generates unique identifiers using the Snowflake - * algorithm, which combines a timestamp, worker ID, and data center ID to + * algorithm, which combines a timestamp, worker ID, and data centre ID to * create 64-bit long integers. The bit distribution for the generated IDs is * as follows: *

*

* When initializing the SnowflakeGuidCreator, you must provide the worker ID - * and data center ID, ensuring they are within the valid range defined by the + * 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 @@ -68,7 +68,7 @@ public final class SnowflakeGuidCreator implements GuidCreator { private final long workerIdBits = 5L; /** - * The number of bits reserved for the data center ID. + * The number of bits reserved for the data centre ID. */ private final long dataCentreIdBits = 5L; @@ -78,7 +78,7 @@ public final class SnowflakeGuidCreator implements GuidCreator { private final long workerId; /** - * The data center ID assigned to this generator. + * The data centre ID assigned to this generator. */ private final long dataCentreId; @@ -94,10 +94,10 @@ public final class SnowflakeGuidCreator implements GuidCreator { /** * Constructs a SnowflakeGuidGenerator with the default start epoch and - * custom worker ID, data center ID. + * custom worker ID, data centre ID. * * @param workerId the worker ID (between 0 and 31). - * @param dataCentreId the data center ID (between 0 and 31). + * @param dataCentreId the data centre ID (between 0 and 31). */ public SnowflakeGuidCreator(long workerId, long dataCentreId) { this(workerId, dataCentreId, DEFAULT_CUSTOM_EPOCH); @@ -105,15 +105,15 @@ public final class SnowflakeGuidCreator implements GuidCreator { /** * Constructs a SnowflakeGuidGenerator with a custom epoch, worker ID, and - * data center ID. + * data centre ID. * * @param startEpoch the custom epoch timestamp (in milliseconds) to * start generating IDs from * @param workerId the worker ID (between 0 and 31) - * @param dataCentreId the data center ID (between 0 and 31) + * @param dataCentreId the data centre ID (between 0 and 31) * @throws IllegalArgumentException if the start epoch is greater than the * current timestamp, or if the worker ID - * or data center ID is out of range + * or data centre ID is out of range */ public SnowflakeGuidCreator(long workerId, long dataCentreId, long startEpoch) { if (startEpoch > currentTimestamp()) { diff --git a/guid/src/main/java/cn/org/codecrafters/guid/exceptions/TimingException.java b/guid/src/main/java/cn/org/codecrafters/guid/exceptions/TimingException.java index 952213b..ab9abae 100644 --- a/guid/src/main/java/cn/org/codecrafters/guid/exceptions/TimingException.java +++ b/guid/src/main/java/cn/org/codecrafters/guid/exceptions/TimingException.java @@ -31,7 +31,7 @@ package cn.org.codecrafters.guid.exceptions; * information about the error. *

* TimingException is typically used to handle exceptions related to timing, - * such as timeouts or synchronization issues. It is a subclass of + * such as timeouts or synchronisation issues. It is a subclass of * RuntimeException, which means it is an unchecked exception and does not need * to be caught or declared. * diff --git a/simple-jwt-authzero/src/main/java/cn/org/codecrafters/simplejwt/authzero/config/package-info.java b/simple-jwt-authzero/src/main/java/cn/org/codecrafters/simplejwt/authzero/config/package-info.java index 5f3abd7..5d6a0ae 100644 --- a/simple-jwt-authzero/src/main/java/cn/org/codecrafters/simplejwt/authzero/config/package-info.java +++ b/simple-jwt-authzero/src/main/java/cn/org/codecrafters/simplejwt/authzero/config/package-info.java @@ -46,7 +46,7 @@ * to configure and use the {@link * cn.org.codecrafters.simplejwt.authzero.AuthzeroTokenResolver} effectively * in the Spring Boot environment to handle JWT authentication and - * authorization securely and efficiently. + * authorisation securely and efficiently. * * @since 1.0.0 */ diff --git a/simple-jwt-authzero/src/main/java/cn/org/codecrafters/simplejwt/authzero/package-info.java b/simple-jwt-authzero/src/main/java/cn/org/codecrafters/simplejwt/authzero/package-info.java index c99a3dd..c8ba91c 100644 --- a/simple-jwt-authzero/src/main/java/cn/org/codecrafters/simplejwt/authzero/package-info.java +++ b/simple-jwt-authzero/src/main/java/cn/org/codecrafters/simplejwt/authzero/package-info.java @@ -19,7 +19,7 @@ * This package contains classes related to the integration of the {@code * com.auth0:java-jwt} library in the Simple JWT project. {@code * com.auth0:java-jwt} is a powerful and widely-used Identity as a Service - * (IDaaS) platform that provides secure authentication and authorization + * (IDaaS) platform that provides secure authentication and authorisation * solutions for web and mobile applications. The classes in this package * provide the necessary functionality to handle JSON Web Tokens (JWTs) using * the {@code com.auth0:java-jwt} library. diff --git a/simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/config/package-info.java b/simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/config/package-info.java index 1a8784c..0fa35ff 100644 --- a/simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/config/package-info.java +++ b/simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/config/package-info.java @@ -22,7 +22,7 @@ * and validation. *

* Other configuration classes may be added in the future to support additional - * customization options and features. Developers using the Simple JWT library + * customisation options and features. Developers using the Simple JWT library * should be familiar with the available configuration options to ensure proper * integration and usage of the library. * diff --git a/simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/package-info.java b/simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/package-info.java index 497d456..490200b 100644 --- a/simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/package-info.java +++ b/simple-jwt-facade/src/main/java/cn/org/codecrafters/simplejwt/package-info.java @@ -24,7 +24,7 @@ * the JWT handling process and provide convenient abstractions for JWT * generation, validation, and extraction. *

- * The Simple JWT library is designed to be flexible and customizable, allowing + * The Simple JWT library is designed to be flexible and customisable, allowing * developers to use different algorithms, token resolvers, and token payload * classes based on their specific application requirements. It aims to * simplify the JWT handling process while maintaining security and best diff --git a/simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/config/package-info.java b/simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/config/package-info.java index fdc87a0..5ebbeaf 100644 --- a/simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/config/package-info.java +++ b/simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/config/package-info.java @@ -46,7 +46,7 @@ * to configure and use the {@link * cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver} effectively * in the Spring Boot environment to handle JWT authentication and - * authorization securely and efficiently. + * authorisation securely and efficiently. * * @since 1.0.0 */ diff --git a/simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/package-info.java b/simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/package-info.java index 2c31f40..5a3eca5 100644 --- a/simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/package-info.java +++ b/simple-jwt-jjwt/src/main/java/cn/org/codecrafters/simplejwt/jjwt/package-info.java @@ -19,7 +19,7 @@ * This package contains classes related to the integration of the {@code * io.jsonwebtoken:jjwt-api} library in the Simple JWT project. {@code * io.jsonwebtoken:jjwt-api} is a powerful and widely-used Identity as a Service - * (IDaaS) platform that provides secure authentication and authorization + * (IDaaS) platform that provides secure authentication and authorisation * solutions for web and mobile applications. The classes in this package * provide the necessary functionality to handle JSON Web Tokens (JWTs) using * the {@code io.jsonwebtoken:jjwt-api} library. diff --git a/webcal/README.md b/webcal/README.md index ec896ed..d421196 100644 --- a/webcal/README.md +++ b/webcal/README.md @@ -2,12 +2,12 @@ ## Introduction -The module `webcal` is a Java library that facilitates the generation and resolution of iCalendar content for web-based calendar applications. It provides a flexible and easy-to-use API for creating web calendars with customizable settings and events. +The module `webcal` is a Java library that facilitates the generation and resolution of iCalendar content for web-based calendar applications. It provides a flexible and easy-to-use API for creating web calendars with customisable settings and events. ### Key features - Create and manage web calendars with events, including event details such as summary, description, location, and more. -- Define event classifications and categories for better organization and filtering of calendar data. +- Define event classifications and categories for better organisation and filtering of calendar data. - Set event start and end times, durations, and time zones to handle various scheduling scenarios. - Configure event priorities and completion percentages for visual representation in the calendar. - Generate iCalendar format output suitable for web calendar applications. diff --git a/webcal/src/main/java/cn/org/codecrafters/webcal/package-info.java b/webcal/src/main/java/cn/org/codecrafters/webcal/package-info.java index ce089b6..3cfd07d 100644 --- a/webcal/src/main/java/cn/org/codecrafters/webcal/package-info.java +++ b/webcal/src/main/java/cn/org/codecrafters/webcal/package-info.java @@ -24,7 +24,7 @@ *