Skip to content

doc: updated README.md #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 16, 2025
Merged

doc: updated README.md #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f900f8b
doc: updated README.md
sttk Feb 16, 2025
482a1ce
doc: fixed the points by review
sttk Feb 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,29 @@
# [stringcase-java][repo-url] [![Maven Central][mvn-img]][mvn-url] [![GitHub.io][io-img]][io-url] [![CI Status][ci-img]][ci-url] [![MIT License][mit-img]][mit-url]

A Java library for converting string cases between camelCase, COBOL-CASE, kebab-case, MACRO_CASE, PascalCase, snake_case and Train-Case.
This library provides some static methods that convert string cases between
camelCase, COBOL-CASE, kebab-case, MACRO_CASE, PascalCase, snake_case and
Train-Case.

Essentially, these static methods only target ASCII uppercase and lowercase letters for
capitalization.
All characters other than ASCII uppercase and lowercase letters and ASCII numbers are removed as
word separators.

If you want to use some symbols as separators, specify those symbols in the `separators` field of
an `Options` instance and use the `〜CaseWithOptions` methods for the desired case.
If you want to retain certain symbols and use everything else as separators, specify those symbols
in `keep` field of an `Options` instance and use the `〜CaseWithOptions` methods for the desired
case.

Additionally, you can specify whether to place word boundaries before and/or after non-alphabetic
characters with conversion options.
This can be set using the `separateBeforeNonAlphabets` and `separateAfterNonAlphabets` fields in
the `Options` instance.

The `〜Case` methods that do not take `Options` as an argument only place word boundaries after
non-alphabetic characters.
In other words, they behave as if
`separateBeforeNonAlphabets = false` and `separateAfterNonAlphabets = true`.

## Install

Expand Down Expand Up @@ -66,11 +89,12 @@ This framework supports JDK 21 or later.

### Actually checked JDK versions:

- GraalVM CE 21.0.2+13.1 (openjdk version 21.0.2)
- Oracle GraalVM 21.0.6+8.1 (java version "21.0.6" 2025-01-21 LTS)
- Oracle GraalVM 23.0.2+7.1 (java version "23.0.2" 2025-01-21)

## License

Copyright (C) 2024 Takayuki Sato
Copyright (C) 2024-2025 Takayuki Sato

This program is free software under MIT License.<br>
See the file LICENSE in this distribution for more details.
Expand Down