From f900f8ba96bee38625ffa2fdfc9e21082cfc01c3 Mon Sep 17 00:00:00 2001 From: sttk Date: Mon, 17 Feb 2025 00:45:54 +0900 Subject: [PATCH 1/2] doc: updated README.md --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b77e0f8..8d0d04c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.
See the file LICENSE in this distribution for more details. From 482a1ce6f0e58ff8c88d2460a7ee7009d0e63b4b Mon Sep 17 00:00:00 2001 From: sttk Date: Mon, 17 Feb 2025 00:52:53 +0900 Subject: [PATCH 2/2] doc: fixed the points by review --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8d0d04c..b69b03e 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,21 @@ 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 +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 +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 +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`. +`separateBeforeNonAlphabets = false` and `separateAfterNonAlphabets = true`. ## Install