Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joutvhu/date-parser
Utility to parse String to Date according to a target class, and the pattern strings. And format Date to String based on a pattern string.
https://github.com/joutvhu/date-parser
date parser time type-class
Last synced: 1 day ago
JSON representation
Utility to parse String to Date according to a target class, and the pattern strings. And format Date to String based on a pattern string.
- Host: GitHub
- URL: https://github.com/joutvhu/date-parser
- Owner: joutvhu
- License: mit
- Created: 2021-06-17T18:59:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-28T07:04:14.000Z (over 1 year ago)
- Last Synced: 2024-11-08T21:41:15.548Z (about 2 months ago)
- Topics: date, parser, time, type-class
- Language: Java
- Homepage:
- Size: 336 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Date Parser
[](https://github.com/joutvhu/date-parser/blob/main/LICENSE)
[](https://codecov.io/gh/joutvhu/date-parser)
This is a Date Utility with two purposes:
- Parse String to Date according to a target class, and the pattern strings.
- Format Date to String based on a pattern string.
## Installation
- If you are using Gradle just add the following dependency to your `build.gradle`.
```groovy
implementation "com.github.joutvhu:date-parser:1.0.0"
```
- Or add the following dependency to your `pom.xml` if you are using Maven.
```xml
com.github.joutvhu
date-parser
1.0.0
```
## Using
### DateFormatter
- `withConvertor(Class typeOfConvertor, Convertor convertor)` or `withConvertor(Convertor convertor)` used to add a custom convertor to the `DateFormatter`.
- Use these methods to add a [`Convertor`](./src/main/java/com/joutvhu/date/parser/convertor/Convertor.java).
- `withLocale(Locale defaultLocale)` used to set default `java.util.Locale`, if this value is null the default value is `Locale.getDefault()`.
- `withZone(TimeZone defaultZone)` used to set default `java.util.TimeZone`, if this value is null the default value is `TimeZone.getDefault()`.
- `withWeekFields(WeekFields defaultWeekFields)` used to set default `java.time.temporal.WeekFields`, if this value is null the default value is `WeekFields.of(locale)`.
- `withStrategyFactory(StrategyFactory strategyFactory)` used to override [`StrategyFactory`](./src/main/java/com/joutvhu/date/parser/strategy/StrategyFactory.java).
- Use this method to add, update or delete a [`Strategy`](./src/main/java/com/joutvhu/date/parser/strategy/Strategy.java).
- `parse(Class type, String value, String... patterns)` used to parse string to date.
- `type` is the type of target object you want to get.
- `value` is the input string you want to convert to the target object.
- `patterns` are the possible formats of the input string.
- `format(T object, String pattern)` used to format an object to a target string.
- `object` is the input object you want to convert to string.
- `pattern` is the format of the target string.
### DateParser
- `DateParser.formatter()` will be return a new [`DateFormatter`](#DateFormatter).
- `DateParser.parse(Class type, String value, String... patterns)` is equivalent to `DateParser.formatter().parse(Class type, String value, String... patterns)`.
- `DateParser.format(T object, String pattern)` is equivalent to `DateParser.formatter().format(T object, String pattern)`.
## Example
- Parse Date
```java
Date date = DateParser.formatter().parse(Date.class, "2021-06-27 21:52:25.408", "yyyy-MM-dd HH:mm:ss.SSS");
LocalDateTime localDateTime = DateParser.parse(LocalDateTime.class, "2021-06-27 21:52:25.408", "yyyy-MM-dd HH:mm:ss.SSS");
Instant instant = DateParser.parse(Instant.class, "2021-06-28T02:22:48.780101Z", "yyyy-MM-dd'T'HH:mm:ss.SSSZ");
DayOfWeek dayOfWeek = DateParser.formatter().withWeekFields(WeekFields.ISO).parse(DayOfWeek.class, "Sun", "E");
```
- Format Date
```java
String date = DateParser.format(new Date(), "MMM dd, yyyy hh:mm:ss a");
String instant = DateParser.format(Instant.now(), "yyyy-MM-dd'T'HH:mm:ss.SSSX");
String yearMonth = DateParser.format(YearMonth.of(2021, Month.DECEMBER), "Mo yyyy");
```