Java date format - including additional characters

Question

Is there an equivalent to php date() style formatting in Java? I mean, in php I can backslash-escape characters to have them treated literally. I.e. yyyy \y\e\a\r would become 2010 year. I did not find anything similar in Java, all examples deal only with built-in date formats.

In particular, I deal with JCalendar date pickers and their dateFormatString property.

I need it because in my locale it is required to write all sorts of additional stuff in date format, like d. (for day) after days part, m. (for years) after years part and so on.

At the worst case I could use string replace or regexp but maybe there's a simpler way?

For anyone reading this in 2019 or later, the `SimpleDateFormat` class used in a couple of the answers is notoriously troublesome and long outdated. Avoid it. Instead use [the short answer by Mark Jeronimus](https://stackoverflow.com/a/49667638/5772882) demonstrating the use of [java.time, the modern Java date and time API](https://docs.oracle.com/javase/tutorial/datetime/). — Ole V.V., Oct 04 '19 at 06:50

score 193 · Accepted Answer · edited Jun 13 '17 at 16:20

193

Sure, with the SimpleDateFormat you can include literal strings:

Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "''" represents a single quote. All other characters are not interpreted; they're simply copied into the output string during formatting or matched against the input string during parsing.

 "hh 'o''clock' a, zzzz"    12 o'clock PM, Pacific Daylight Time

edited Jun 13 '17 at 16:20

Jouramie

179
5
16

answered Jan 26 '10 at 08:05

Thilo

257,207
101
511
656

Super, thats exactly what I need. Surprisingly I haven't found such simple thing in any of numerous examples I browsed in web :) Thanks a lot! – Sejanus Jan 26 '10 at 11:20
1

How do I escape quote character? I'm trying to do something with the format mm'. Indicating for example 46 minutes like 46'. – Sotti Oct 29 '14 at 12:07
3

@Sotti: `46''`. The first to escape the second. – Thilo Oct 30 '14 at 00:52
1

FYI, the terribly troublesome date-time classes such as [`java.util.Date`](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html), [`java.util.Calendar`](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Calendar.html), and `java.text.SimpleDateFormat` are now [legacy](https://en.wikipedia.org/wiki/Legacy_system), supplanted by the [*java.time*](https://docs.oracle.com/javase/tutorial/datetime/TOC.html) classes built into Java 8 and later. – Basil Bourque Oct 04 '19 at 20:37
This is the what I was exactly looking for, Thanks! – Alex Sep 20 '21 at 01:27

score 38 · Answer 2 · answered Apr 05 '18 at 08:29

38

Just for completeness, Java 8's DateTimeFormatter also supports this:

DateTimeFormatter.ofPattern("yyyy 'year'");

answered Apr 05 '18 at 08:29

Mark Jeronimus

9,278
3
37
50

score 10 · Answer 3 · edited Oct 04 '19 at 20:39

java.time

Mark Jeronimus said it already. I am fleshing it out a bit more. Just put the text to be printed literally inside single quotes.

    DateTimeFormatter yearFormatter = DateTimeFormatter.ofPattern("yyyy 'year'");
    System.out.println(LocalDate.of(2010, Month.FEBRUARY, 3).format(yearFormatter));
    System.out.println(Year.of(2010).format(yearFormatter));
    System.out.println(ZonedDateTime.now(ZoneId.of("Europe/Vilnius")).format(yearFormatter));

Output when running just now:

2010 year
2010 year
2019 year

If you are using a DateTimeFormatterBuilder and its appendPattern method, use single quotes in the same way. Or use its appendLiteral method instead and no single quotes.

How do we put a single quote in the format, then? Two single quotes produce one. It doesn’t matter if the double single quote is inside single quotes or not:

    DateTimeFormatter formatterWithSingleQuote = DateTimeFormatter.ofPattern("H mm'' ss\"");
    System.out.println(LocalTime.now(ZoneId.of("Europe/London")).format(formatterWithSingleQuote));

10 28' 34"

    DateTimeFormatter formatterWithSingleQuoteInsideSingleQuotes
            = DateTimeFormatter.ofPattern("hh 'o''clock' a, zzzz", Locale.ENGLISH);
    System.out.println(ZonedDateTime.now(ZoneId.of("America/Los_Angeles"))
            .format(formatterWithSingleQuoteInsideSingleQuotes));

02 o'clock AM, Pacific Daylight Time

All of the formatters above can be used for parsing too. For example:

    LocalTime time = LocalTime.parse("16 43' 56\"", formatterWithSingleQuote);
    System.out.println(time);

16:43:56

The SimpleDateFormat class used when this question was asked nearly 10 years ago is notoriously troublesome and long outdated. I recommend that instead you use java.time, the modern Java date and time API. Which is why I demonstrate just that.

Links

Oracle tutorial: Date Time explaining how to use java.time.
Documentation of DateTimeFormatter

score 6 · Answer 4 · edited Jun 28 '17 at 20:57

6

You can use String.format as documented in java.util.Formatter:

Calendar c = ...;
String s = String.format("%tY year", c);
// -> s == "2010 year" or whatever the year actually is

edited Jun 28 '17 at 20:57

Dan

7,286
6
49
114

answered Jan 26 '10 at 07:56

R Samuel Klatchko

74,869
16
134
187

score -4 · Answer 5 · answered Jan 26 '10 at 08:02

-4

java.text.SimpleDateFormat

SimpleDateFormat formatter = new SimpleDateFormat("yyyy/MM/dd"); 
String formattedDate = formatter.format(date);

You'll get more info here link text

answered Jan 26 '10 at 08:02

Javi

19,387
30
102
135

Java date format - including additional characters

5 Answers5

java.time

Links

Linked

Related