Skip to content

Commit 3946bd6

Browse files
committed
feat: add docs of java-dev-kit
1 parent fcc6d24 commit 3946bd6

File tree

8 files changed

+82
-0
lines changed

8 files changed

+82
-0
lines changed

src/projects/java-dev-kit/api.md

Whitespace-only changes.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
## v2.3.0 (12 Jun 2025)
4+
5+
- feat: deprecate reflect map util by @siujamo in #67
6+
- feat: removed `property-guard-spring-boot-starter` by @zihluwang
7+
- feat: import key loading method by @siujamo in #68

src/projects/java-dev-kit/index.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Java Dev Kit <Badge type="info">2.3.0</Badge>
2+
3+
Java Dev Kit is an open-source enterprise-grade Java development toolkit suite, designed to
4+
streamline and enhance your software development workflow. It provides a collection of modular tools
5+
and utilities tailored for various aspects of Java application development.
6+
7+
## Features
8+
9+
### 1. Version Management Module
10+
This module handles overall project management by utilising a BOM (Bill of Materials) to uniformly
11+
manage the versions of all imported dependencies, ensuring consistency and reducing version
12+
conflicts across your projects.
13+
14+
### 2. Development Utility Tools
15+
A comprehensive set of practical utilities to simplify common development tasks, including but not
16+
limited to:
17+
18+
- **AesUtil**: Provides AES encryption functionality.
19+
- **Base64Util**: Performs Base64 encoding and decoding for strings.
20+
- **BoolUtil**: Executes logical AND and OR operations on multiple boolean expressions.
21+
- **BranchUtil**: Reduces verbose `if-else` statements by combining `BoolUtil` with Lambda expressions for cleaner conditional flows.
22+
- **CollectionUtil**: Utilities designed for convenient and efficient collection handling.
23+
- **HashUtil**: Offers hashing operations on strings using various algorithms.
24+
- **MapUtil** and **ObjectMapAdapter**: Facilitate conversions between `Map` objects and specified Java classes.
25+
- **RangeUtil**: Generates ranged arrays based on specified bounds.
26+
27+
### 3. Global Unique ID Generator
28+
A dedicated module providing a variety of generators for creating different types of globally unique
29+
identifiers (GUIDs), suitable for distributed systems and enterprise applications.
30+
31+
### 4. Key Pair Loading Utilities
32+
Tools to load PEM-format key pair files (`PublicKey` and `PrivateKey`) into their corresponding Java
33+
objects. This utility can also be integrated within the main development utilities module for
34+
better cohesion.
35+
36+
### 5. Mathematics and Statistics Utilities
37+
A set of tools for mathematical and statistical computations, currently supporting:
38+
39+
- Chainable high-precision calculations.
40+
- Quartile computations.
41+
42+
Consideration is given to merging this into the development utilities module for simplicity and
43+
easy access.
44+
45+
### 6. JWT Tools
46+
Employing a facade pattern, Java Dev Kit allows the utilisation of various implementations for
47+
generating, parsing, and verifying JSON Web Tokens (JWT), making token management flexible
48+
and extensible.
49+
50+
### 7. Serial Number Generator
51+
A utility to generate serial numbers following specified formats, useful for identifiers,
52+
order numbers, and other sequential data.
53+
54+
## Getting Started
55+
56+
To include Java Dev Kit in your project, please refer to the version management module’s BOM to
57+
ensure you use compatible and consistent dependency versions.
58+
59+
## Contributing
60+
61+
Java Dev Kit is open source and welcomes contributions. Please feel free to submit issues and pull
62+
requests to help improve the toolkit.
63+
64+
## Licence
65+
66+
This project is licensed under the Apache Licence. See the LICENSE file for details.
67+
68+
---
69+
70+
For more detailed documentation on each module and usage examples, please refer to the `/docs`
71+
directory or visit the project wiki.
72+
73+
---
74+
75+
Thank you for using Java Dev Kit, your trusted companion for enterprise Java development.

src/projects/java-dev-kit/usage.md

Whitespace-only changes.

src/zh-CN/projects/java-dev-kit/api.md

Whitespace-only changes.

src/zh-CN/projects/java-dev-kit/changelog.md

Whitespace-only changes.

src/zh-CN/projects/java-dev-kit/index.md

Whitespace-only changes.

src/zh-CN/projects/java-dev-kit/usage.md

Whitespace-only changes.

0 commit comments

Comments
 (0)