-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some README files to give an overview of each artifacts
- Loading branch information
1 parent
ba2b63f
commit 1c0845f
Showing
3 changed files
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Compile Time Plugin for `StringFormat` | ||
|
||
The `com.google.mu.util.StringFormat` class in Mug and `com.google.mu.safesql.SafeQuery` class provide parsing and formatting functionality based on a string template. This artifact provides compile-time checks to help using these classes safely. | ||
|
||
If you use bazel, the `mug:format` and `mug-guava:safe_sql` build targets export the plugin out of the box. | ||
|
||
If you use Maven, add the following POM snippet to your `maven-compiler-plugin`: | ||
|
||
``` | ||
<configuration> | ||
<annotationProcessorPaths> | ||
<path> | ||
<groupId>com.google.errorprone</groupId> | ||
<artifactId>error_prone_core</artifactId> | ||
<version>2.23.0</version> | ||
</path> | ||
<path> | ||
<groupId>com.google.mug</groupId> | ||
<artifactId>mug-errorprone</artifactId> | ||
<version>7.0</version> | ||
</path> | ||
</configuration> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Using Mug with Guava | ||
|
||
This artifact provides utilities with both Mug and Guava dependencies. | ||
|
||
* `SafeQuery` builds SQL queries using the same template syntax as `StringFormat`, while preventing SQL injection. | ||
* `GuavaCollectors` provide extra `Collector` and `BiCollector`s. | ||
* `CaseBreaker` helps breaking apart camelCase, snake_case, UPPER_SNAKE_CASE and dash-case words. | ||
* `BinarySearch` is a generic binary search algorithm that can be used for use cases beyond `List` and arrays. | ||
* `Immutables` has more convenient factory methods for Guava immutable collections. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Extra protobuf utilities |