Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bump version. Update README and tests.
- Loading branch information
Showing
3 changed files
with
52 additions
and
5 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 |
---|---|---|
@@ -1,10 +1,55 @@ | ||
# Exceptional | ||
|
||
[![](https://img.shields.io/badge/License-MPL--2.0-blue)](./LICENSE "Project license: MPL-2.0") | ||
[![](https://img.shields.io/badge/Java-11-orange)](# "This project targets Java 11") | ||
[![](https://img.shields.io/maven-central/v/com.rezzedup.util/exceptional?color=ok&label=Maven%20Central)](https://search.maven.org/artifact/com.rezzedup.util/exceptional "Maven Central") | ||
[![](https://img.shields.io/badge/License-MPL--2.0-blue)](./LICENSE "Project License: MPL-2.0") | ||
[![](https://img.shields.io/badge/Java-11-orange)](# "Java Version: 11") | ||
[![javadoc](https://javadoc.io/badge2/com.rezzedup.util/exceptional/javadoc.svg?label=Javadoc&color=%234D7A97)](https://javadoc.io/doc/com.rezzedup.util/exceptional "View Javadocs") | ||
|
||
Utilities for handling exceptions. | ||
|
||
```java | ||
List<String> lines = Attempt.ignoring(() -> Files.readAllLines(Path.of("example.txt"))).orElseGet(List::of); | ||
``` | ||
|
||
## Maven | ||
|
||
*`Coming soon!`* | ||
```xml | ||
<dependency> | ||
<groupId>com.rezzedup.util</groupId> | ||
<artifactId>exceptional</artifactId> | ||
<version><!--release--></version> | ||
</dependency> | ||
``` | ||
|
||
### Versions | ||
|
||
Find available versions on the releases page of this repository. | ||
|
||
Maven Central: https://search.maven.org/artifact/com.rezzedup.util/exceptional | ||
|
||
<details id="note-snapshot-versions"> | ||
<summary><b>Note:</b> <i>Snapshot Versions</i></summary> | ||
|
||
> [ℹ️](#note-snapshot-versions) | ||
> Snapshot releases are available at the following repository: | ||
> | ||
> ```xml | ||
> <repositories> | ||
> <repository> | ||
> <id>ossrh-snapshots</id> | ||
> <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url> | ||
> </repository> | ||
> </repositories> | ||
> ``` | ||
</details> | ||
### Documentation | ||
|
||
Javadoc: https://javadoc.io/doc/com.rezzedup.util/exceptional | ||
|
||
### Shading | ||
|
||
If you intend to shade this library, please consider **relocating** the packages | ||
to avoid potential conflicts with other projects. This library also utilizes | ||
nullness annotations, which may be undesirable in a shaded uber-jar. They can | ||
safely be excluded, and you are encouraged to do so. |
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
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