What is UStream?

![Gitter](https://badges.gitter.im/Join Chat.svg)

UStream (Unix Stream) is an extension of the Java 8 Stream API to process data pipelines the Unix way. It provides a set of components that mimic Unix commands (and more).

Features

100% compatible with Java 8 Streams
Intuitive, flexible and extensible API
A toolbox of reusable components
No dependencies
Free and open source

How to use it?

You can use UStream in two ways:

1. Either unixifiy your stream and process it the unix way:

Stream<String> stream = Stream.of("foo", "bar", "bar", "baz");

UStream.unixify(stream)
        .grep("a")
        .sort()
        .uniq()
        .nl()
        .to(stdOut());
        
// prints:
// 1 bar
// 2 baz

2. Or write your pipelines as you read them

// cat input.txt | grep a | sort | uniq | nl > output.txt

UStream.cat("input.txt")
        .pipe(grep("a"))
        .pipe(sort())
        .pipe(uniq())
        .pipe(nl())
        .to(file("output.txt"));

Where to find it?

Add the following maven dependency to your project:

<dependency>
   <groupId>io.github.benas</groupId>
   <artifactId>ustream</artifactId>
   <version>0.2</version>
</dependency>

Or download the jar file and add it to your application's classpath.

Components library

UStream provides a toolbox of reusable components that mimic Unix commands (and more). Components are inspired by the Unix philosophy and are intended to be:

Small
Portable
Do one thing and do it well
Side-effect free

Here are some of the built-in components:

You can find a complete reference of components in the wiki page.

How to extend it ?

The Stage interface represents a stage of the pipeline:

public interface Stage<I,O> {

  Stream<O> apply(Stream<I> input);

}

All built-in components are implemented as filters/transformers through this interface. You can of course implement this interface to create your own components.

Contribution

There are a lot of options for current components that are not implemented yet. You are welcome to improve existing components or add new ones to make the toolbox as rich as possible!

License

UStream is released under the MIT License:

The MIT License

Copyright (c) 2015, Mahmoud Ben Hassine (mahmoud@benhassine.fr)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

bpbhat77/ustream