docs(global): Changed spelling with BrE.
This commit is contained in:
@@ -27,7 +27,7 @@ A module for generating globally unique IDs. It includes a facade interface and
|
|||||||
|
|
||||||
<span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/webcal/README.md)_</span>
|
<span style="font-size: 14px;">_[Learn more](https://github.com/CodeCraftersCN/jdevkit/webcal/README.md)_</span>
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ import java.util.function.Function;
|
|||||||
* The ChainedCalcUtil class provides a convenient way to perform chained
|
* The ChainedCalcUtil class provides a convenient way to perform chained
|
||||||
* high-precision calculations using BigDecimal. It allows users to perform
|
* high-precision calculations using BigDecimal. It allows users to perform
|
||||||
* mathematical operations such as addition, subtraction, multiplication,
|
* 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
|
* class, developers can achieve accurate results and avoid precision loss
|
||||||
* in their calculations.
|
* in their calculations.
|
||||||
* <p>
|
* <p>
|
||||||
|
|||||||
@@ -26,19 +26,19 @@ import java.time.ZoneOffset;
|
|||||||
* SnowflakeGuidCreator - GUID generator based on the Snowflake algorithm.
|
* SnowflakeGuidCreator - GUID generator based on the Snowflake algorithm.
|
||||||
* <p>
|
* <p>
|
||||||
* The SnowflakeGuidCreator generates unique identifiers using the Snowflake
|
* 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
|
* create 64-bit long integers. The bit distribution for the generated IDs is
|
||||||
* as follows:
|
* as follows:
|
||||||
* <ul>
|
* <ul>
|
||||||
* <li>1 bit for sign</li>
|
* <li>1 bit for sign</li>
|
||||||
* <li>41 bits for timestamp (in milliseconds)</li>
|
* <li>41 bits for timestamp (in milliseconds)</li>
|
||||||
* <li>5 bits for data center ID</li>
|
* <li>5 bits for data centre ID</li>
|
||||||
* <li>5 bits for worker ID</li>
|
* <li>5 bits for worker ID</li>
|
||||||
* <li>12 bits for sequence number (per millisecond)</li>
|
* <li>12 bits for sequence number (per millisecond)</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
* <p>
|
* <p>
|
||||||
* When initializing the SnowflakeGuidCreator, you must provide the worker ID
|
* 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
|
* bit size. The generator maintains an internal sequence number that
|
||||||
* increments for IDs generated within the same millisecond. If the system
|
* increments for IDs generated within the same millisecond. If the system
|
||||||
* clock moves backward, an exception is thrown to prevent generating IDs with
|
* clock moves backward, an exception is thrown to prevent generating IDs with
|
||||||
@@ -68,7 +68,7 @@ public final class SnowflakeGuidCreator implements GuidCreator<Long> {
|
|||||||
private final long workerIdBits = 5L;
|
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;
|
private final long dataCentreIdBits = 5L;
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ public final class SnowflakeGuidCreator implements GuidCreator<Long> {
|
|||||||
private final long workerId;
|
private final long workerId;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The data center ID assigned to this generator.
|
* The data centre ID assigned to this generator.
|
||||||
*/
|
*/
|
||||||
private final long dataCentreId;
|
private final long dataCentreId;
|
||||||
|
|
||||||
@@ -94,10 +94,10 @@ public final class SnowflakeGuidCreator implements GuidCreator<Long> {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs a SnowflakeGuidGenerator with the default start epoch and
|
* 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 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) {
|
public SnowflakeGuidCreator(long workerId, long dataCentreId) {
|
||||||
this(workerId, dataCentreId, DEFAULT_CUSTOM_EPOCH);
|
this(workerId, dataCentreId, DEFAULT_CUSTOM_EPOCH);
|
||||||
@@ -105,15 +105,15 @@ public final class SnowflakeGuidCreator implements GuidCreator<Long> {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructs a SnowflakeGuidGenerator with a custom epoch, worker ID, and
|
* 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
|
* @param startEpoch the custom epoch timestamp (in milliseconds) to
|
||||||
* start generating IDs from
|
* start generating IDs from
|
||||||
* @param workerId the worker ID (between 0 and 31)
|
* @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
|
* @throws IllegalArgumentException if the start epoch is greater than the
|
||||||
* current timestamp, or if the worker ID
|
* 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) {
|
public SnowflakeGuidCreator(long workerId, long dataCentreId, long startEpoch) {
|
||||||
if (startEpoch > currentTimestamp()) {
|
if (startEpoch > currentTimestamp()) {
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ package cn.org.codecrafters.guid.exceptions;
|
|||||||
* information about the error.
|
* information about the error.
|
||||||
* <p>
|
* <p>
|
||||||
* TimingException is typically used to handle exceptions related to timing,
|
* 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
|
* RuntimeException, which means it is an unchecked exception and does not need
|
||||||
* to be caught or declared.
|
* to be caught or declared.
|
||||||
*
|
*
|
||||||
|
|||||||
+1
-1
@@ -46,7 +46,7 @@
|
|||||||
* to configure and use the {@link
|
* to configure and use the {@link
|
||||||
* cn.org.codecrafters.simplejwt.authzero.AuthzeroTokenResolver} effectively
|
* cn.org.codecrafters.simplejwt.authzero.AuthzeroTokenResolver} effectively
|
||||||
* in the Spring Boot environment to handle JWT authentication and
|
* in the Spring Boot environment to handle JWT authentication and
|
||||||
* authorization securely and efficiently.
|
* authorisation securely and efficiently.
|
||||||
*
|
*
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*/
|
*/
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@
|
|||||||
* This package contains classes related to the integration of the {@code
|
* 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} library in the Simple JWT project. {@code
|
||||||
* com.auth0:java-jwt} is a powerful and widely-used Identity as a Service
|
* 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
|
* solutions for web and mobile applications. The classes in this package
|
||||||
* provide the necessary functionality to handle JSON Web Tokens (JWTs) using
|
* provide the necessary functionality to handle JSON Web Tokens (JWTs) using
|
||||||
* the {@code com.auth0:java-jwt} library.
|
* the {@code com.auth0:java-jwt} library.
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@
|
|||||||
* and validation.
|
* and validation.
|
||||||
* <p>
|
* <p>
|
||||||
* Other configuration classes may be added in the future to support additional
|
* 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
|
* should be familiar with the available configuration options to ensure proper
|
||||||
* integration and usage of the library.
|
* integration and usage of the library.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -24,7 +24,7 @@
|
|||||||
* the JWT handling process and provide convenient abstractions for JWT
|
* the JWT handling process and provide convenient abstractions for JWT
|
||||||
* generation, validation, and extraction.
|
* generation, validation, and extraction.
|
||||||
* <p>
|
* <p>
|
||||||
* 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
|
* developers to use different algorithms, token resolvers, and token payload
|
||||||
* classes based on their specific application requirements. It aims to
|
* classes based on their specific application requirements. It aims to
|
||||||
* simplify the JWT handling process while maintaining security and best
|
* simplify the JWT handling process while maintaining security and best
|
||||||
|
|||||||
+1
-1
@@ -46,7 +46,7 @@
|
|||||||
* to configure and use the {@link
|
* to configure and use the {@link
|
||||||
* cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver} effectively
|
* cn.org.codecrafters.simplejwt.jjwt.JjwtTokenResolver} effectively
|
||||||
* in the Spring Boot environment to handle JWT authentication and
|
* in the Spring Boot environment to handle JWT authentication and
|
||||||
* authorization securely and efficiently.
|
* authorisation securely and efficiently.
|
||||||
*
|
*
|
||||||
* @since 1.0.0
|
* @since 1.0.0
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -19,7 +19,7 @@
|
|||||||
* This package contains classes related to the integration of the {@code
|
* 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} library in the Simple JWT project. {@code
|
||||||
* io.jsonwebtoken:jjwt-api} is a powerful and widely-used Identity as a Service
|
* 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
|
* solutions for web and mobile applications. The classes in this package
|
||||||
* provide the necessary functionality to handle JSON Web Tokens (JWTs) using
|
* provide the necessary functionality to handle JSON Web Tokens (JWTs) using
|
||||||
* the {@code io.jsonwebtoken:jjwt-api} library.
|
* the {@code io.jsonwebtoken:jjwt-api} library.
|
||||||
|
|||||||
+2
-2
@@ -2,12 +2,12 @@
|
|||||||
|
|
||||||
## Introduction
|
## 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
|
### Key features
|
||||||
|
|
||||||
- Create and manage web calendars with events, including event details such as summary, description, location, and more.
|
- 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.
|
- 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.
|
- Configure event priorities and completion percentages for visual representation in the calendar.
|
||||||
- Generate iCalendar format output suitable for web calendar applications.
|
- Generate iCalendar format output suitable for web calendar applications.
|
||||||
|
|||||||
@@ -24,7 +24,7 @@
|
|||||||
* <ul>
|
* <ul>
|
||||||
* <li>
|
* <li>
|
||||||
* {@link cn.org.codecrafters.webcal.WebCalendar}: A class for
|
* {@link cn.org.codecrafters.webcal.WebCalendar}: A class for
|
||||||
* generating web calendars with customizable settings and events.
|
* generating web calendars with customisable settings and events.
|
||||||
* </li>
|
* </li>
|
||||||
* <li>
|
* <li>
|
||||||
* {@link cn.org.codecrafters.webcal.WebCalendarEvent}: A class
|
* {@link cn.org.codecrafters.webcal.WebCalendarEvent}: A class
|
||||||
|
|||||||
Reference in New Issue
Block a user