Skip to content

[LANG-1827] Support escaped single quotes ('') in DurationFormatUtils format patterns #1700

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

Open
sarankumarbaskar wants to merge 2 commits into
base: master
Choose a base branch
from
+55 −9
Open

[LANG-1827] Support escaped single quotes ('') in DurationFormatUtils format patterns #1700

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79b4bc1
Support escaped single quotes ('') in DurationFormatUtils format patt…
Jun 11, 2026
ef2a388
[LANG-1827] Parameterize escaped quote tests
Jun 15, 2026
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
29 changes: 22 additions & 7 deletions src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@
* <tr><td>s</td><td>seconds</td></tr>
* <tr><td>S</td><td>milliseconds</td></tr>
* <tr><td>'text'</td><td>arbitrary text content</td></tr>
* <tr><td>''</td><td>literal single quote (apostrophe)</td></tr>
* </table>
*
* <strong>Note: It's not currently possible to include a single-quote in a format.</strong>
* A literal single quote is represented by a pair of consecutive single quotes ({@code ''}).
* <p>
* Token values are printed using decimal digits.
* A token character can be repeated to ensure that the field occupies a certain minimum
Expand Down Expand Up @@ -669,7 +670,6 @@ static Token[] lexx(final String format) {
}
String value = null;
switch (ch) {
// TODO: Need to handle escaping of '
case '[':
if (inOptional) {
throw new IllegalArgumentException("Nested optional block at index: " + i);
Expand All @@ -685,12 +685,27 @@ static Token[] lexx(final String format) {
break;
case '\'':
if (inLiteral) {
buffer = null;
inLiteral = false;
if (i + 1 < format.length() && format.charAt(i + 1) == '\'') {
// escaped quote '' ? append literal apostrophe, stay in literal
buffer.append('\'');
i++;
} else {
// end of literal
buffer = null;
inLiteral = false;
}
} else {
buffer = new StringBuilder();
list.add(new Token(buffer, inOptional, optionalIndex));
inLiteral = true;
if (i + 1 < format.length() && format.charAt(i + 1) == '\'') {
// standalone '' outside a literal ? emit a single apostrophe
buffer = new StringBuilder("'");
list.add(new Token(buffer, inOptional, optionalIndex));
buffer = null;
i++;
} else {
buffer = new StringBuilder();
list.add(new Token(buffer, inOptional, optionalIndex));
inLiteral = true;
}
}
break;
case 'y':
Expand Down
22 changes: 20 additions & 2 deletions src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ void testFormatPeriod() {
cal.set(Calendar.MILLISECOND, 0);
time = cal.getTime().getTime();
assertEquals("40", DurationFormatUtils.formatPeriod(time1970, time, "yM"));
assertEquals("4 years 0 months", DurationFormatUtils.formatPeriod(time1970, time, "y' ''years' M 'months'"));
assertEquals("4 'years 0 months", DurationFormatUtils.formatPeriod(time1970, time, "y' ''years' M 'months'"));
assertEquals("4 years 0 months", DurationFormatUtils.formatPeriod(time1970, time, "y' years 'M' months'"));
assertEquals("4years 0months", DurationFormatUtils.formatPeriod(time1970, time, "y'years 'M'months'"));
assertEquals("04/00", DurationFormatUtils.formatPeriod(time1970, time, "yy/MM"));
Expand All @@ -470,7 +470,7 @@ void testFormatPeriod() {
assertEquals("048", DurationFormatUtils.formatPeriod(time1970, time, "MMM"));
// no date in result
assertEquals("hello", DurationFormatUtils.formatPeriod(time1970, time, "'hello'"));
assertEquals("helloworld", DurationFormatUtils.formatPeriod(time1970, time, "'hello''world'"));
assertEquals("hello'world", DurationFormatUtils.formatPeriod(time1970, time, "'hello''world'"));
}

@Test
Expand Down Expand Up @@ -584,6 +584,24 @@ void testLANG815() {
void testLANG981() { // unmatched quote char in lexx
assertIllegalArgumentException(() -> DurationFormatUtils.lexx("'yMdHms''S"));
}

@Test
void testLANG1827() {

@garydgregory garydgregory Jun 15, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @Sarankumar18
Please write this new test as a @ParameterizedTest so that we can run all input/output individually and see them all fail if the main side of the patch is not applied.

@sarankumarbaskar sarankumarbaskar Jun 15, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@garydgregory I've made as parametrize test for testLANG1827

@sarankumarbaskar sarankumarbaskar Jun 23, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@garydgregory Are we good to merge this PR ?

final long twoHours = Duration.ofHours(2).toMillis();
final long twoHoursThirtyMin = Duration.ofHours(2).plusMinutes(30).toMillis();
final long oneDayTwoHours = Duration.ofDays(1).plusHours(2).toMillis();

assertEquals("2 o'clock", DurationFormatUtils.formatDuration(twoHours, "H' o''clock'"));
assertEquals("it's 2 hours", DurationFormatUtils.formatDuration(twoHours, "'it''s 'H' hours'"));
assertEquals("2'30", DurationFormatUtils.formatDuration(twoHoursThirtyMin, "H''m"));
assertEquals("it's been 1 day's and 2 hour's",
DurationFormatUtils.formatDuration(oneDayTwoHours, "'it''s been 'd' day''s and 'H' hour''s'"));
assertEquals("2h'30m", DurationFormatUtils.formatDuration(twoHoursThirtyMin, "H'h'''m'm'"));
assertEquals("2 hour's", DurationFormatUtils.formatDuration(twoHours, "[d' day''s ']H' hour''s'"));
assertEquals("2 hours 30 minutes", DurationFormatUtils.formatDuration(twoHoursThirtyMin, "H' hours 'm' minutes'"));
assertIllegalArgumentException(() -> DurationFormatUtils.lexx("'unmatched"));
}

@Test
void testLANG982() { // More than 3 millisecond digits following a second
assertEquals("61.999", DurationFormatUtils.formatDuration(61999, "s.S"));
Expand Down
Loading