Skip to content

Commit e7d5675

Browse files
authored
Update README.md
1 parent cd43caf commit e7d5675

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
1-
# util
2-
Java Util Library ![Java CI with Gradle](https://github.com/javaquery/util/workflows/Java%20CI%20with%20Gradle/badge.svg)
1+
# JavaQuery Util Library
2+
Welcome to the JavaQuery util library
3+
4+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.javaquery/util/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.javaquery/util)
5+
6+
# Overview
7+
Goal is to remove repeated boler plate utility code from your project. This library offers util classes of following framework and objects.
8+
9+
- <b>Collections</b>: Provides wide range of operation you perform on collection (List, Set and Map) interfaces like <code>nullOrEmpty(Collection)</code>, <code>nonNullNonEmpty(Collection)</code>, <code>batches(List<T> source, int batchSize)</code>, etc...
10+
- <b>Files</b>: Provides wide range of operation you perform on <code>java.io.File</code> like <code>createNewFile(T file)</code>, <code>writeToFile(T file, String data)</code>, <code>appendToFile(T file, String data, boolean appendNewLine)</code>, etc...
11+
- <b>Strings</b>: Provides wide range of operation you perform on <code>java.lang.String</code> like <code>nullOrEmpty(String str)</code>, <code>joinStrings(String separator, String... strings)</code>, <code>removeNotSupportedASCIICharacters(String str)</code>, etc...
12+
- <b>DatePattern</b>: Provides wide range of Date patterns commonly used worldwide like <code>yyyyMMddHHmmss</code>, <code>yyyy-MM-dd HH:mm:ss'Z'</code>, <code>yyyy-MM-dd'T'HH:mm:ss.SSSSSSS-HH:MM</code>, etc...
13+
- <b>DateRange</b>: Class can be used to store start-date and end-date.
14+
- <b>Dates</b>: Provides wide range of operation you perform on <code>java.util.Date</code> like <code>addInDate(Date date, int type, int amount)</code>, <code>parse(String date, DatePattern datePattern, TimeZone timeZone)</code>, <code>format(Date date, DatePattern datePattern, TimeZone timeZone)</code>, etc...
15+
- <b>Assert</b>: Provides wide range of operation for Assertions like <code>nonNull(Object object, Supplier<T> exceptionSupplier)</code>, <code>isTrue(boolean expression, Supplier<T> exceptionSupplier)</code>, <code>nonNullNonEmpty(Collection<?> collection, Supplier<T> exceptionSupplier)</code>, etc...
16+
- <b>Objects</b>: Provides wide range of operation on <code>java.lang.Object</code> like <code>isNull(Object obj)</code>, <code>nonNull(Object obj)</code>.
17+
- <b>Regex</b>: Provides wide range of operation using regular expression like <code>isNumber(String value)</code>, <code>isAlphaNumeric(String value)</code>, <code>isValidEmail(String value)</code>.
18+
19+
# Maven
20+
```
21+
<dependency>
22+
<groupId>com.javaquery</groupId>
23+
<artifactId>util</artifactId>
24+
<version>1.0.1</version>
25+
</dependency>
26+
```
27+
28+
# Gradle
29+
```
30+
implementation 'com.javaquery:util:1.0.1'
31+
```

0 commit comments

Comments
 (0)