Skip to content
This repository has been archived by the owner on Jan 4, 2020. It is now read-only.

Commit

Permalink
restructured
Browse files Browse the repository at this point in the history
  • Loading branch information
Torsten Krause committed Apr 20, 2016
1 parent f0f2003 commit aebdab3
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,21 @@
[![Issues](https://img.shields.io/github/issues/markenwerk/java-utils-data-fetcher.svg)](https://github.com/markenwerk/java-utils-data-fetcher/issues)
[![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/markenwerk/java-utils-data-fetcher/blob/master/LICENSE)


## Overview

This is a simple helper to fetch the complete content of an input stream or a readable. It is, among other things, intended as an alternative to using [`IOUtils#readFully`](http://grepcode.com/file/repository.grepcode.com/java/root/jdk/openjdk/7u40-b43/sun/misc/IOUtils.java#IOUtils.readFully%28java.io.InputStream%2Cint%2Cboolean%29) for this everyday task.

Consult the [documentation](http://markenwerk.github.io/java-utils-data-fetcher/index.html) and the [usage description](#usage) for further information:

- [Fetching `byte` streams](#fetching-byte-streams)
- [Fetching `char` streams](#fetching-char-streams)
- [Automatic closing of supplied streams](#automatic-closing-of-supplied-streams)
- [Listen to fetch progress](#listen-to-fetch-progress)
- [Handling of `null` arguments](#handling-of-null-arguments)
- [Customizability](#customizability)

## Maven

This library is hosted in the [Maven Central Repository](https://maven-badges.herokuapp.com/maven-central/net.markenwerk/utils-data-fetcher). You can use it with the following coordinates:

```xml
Expand All @@ -29,8 +32,6 @@ This library is hosted in the [Maven Central Repository](https://maven-badges.he
</dependency>
```

Consult the [usage description](#usage) and [Javadoc](http://markenwerk.github.io/java-utils-data-fetcher/index.html) for further information.

## Motivation

Copying the complete content of an [`InputStream`][InputStream] into a `byte[]` or into an [`OutputStream`][OutputStream] is a menial task, that has to be dealt with very commonly. While this is certainly not a difficult challenge for any programmer, it is still boring and annoying to do it over and over again, and – as pretty much everything – prone to be erroneously, if done in a hurry.
Expand Down

0 comments on commit aebdab3

Please sign in to comment.