|
1 | 1 | = Functional Java |
2 | 2 |
|
| 3 | +image:https://travis-ci.org/functionaljava/functionaljava.svg?branch=master["Build Status", link="https://travis-ci.org/functionaljava/functionaljava"] |
| 4 | + |
3 | 5 | image::http://www.functionaljava.org/img/logo-600x144.png[] |
4 | 6 |
|
5 | 7 | Functional Java is an open source library facilitating functional programming in Java. The library implements numerous basic and advanced programming abstractions that assist composition oriented development. Functional Java also serves as a platform for learning functional programming concepts by introducing these concepts using a familiar language. |
6 | 8 |
|
7 | | -The library is intended for use in production applications and is thoroughly tested using the technique of automated specification-based testing with ScalaCheck. Functional Java is compiled with Java 8 targeting Java 7 bytecode. The use of lambdas within the project are backported with the Retro Lambda library, supporting Java versions 5 to 8. |
| 9 | +The library is intended for use in production applications and is thoroughly tested using the technique of automated specification-based testing with ScalaCheck and Functional Java's quickcheck module. Functional Java is compiled with Java 8 targeting Java 7 bytecode. The use of lambdas within the project are backported with the Retro Lambda library, supporting Java versions 5 to 8. |
8 | 10 |
|
9 | 11 | Functional Java provides abstractions for the following types: |
10 | 12 |
|
11 | 13 | * Basic Data Structures - total and partial functions, products, unit, option, unbiased and right biased unions (either and validation). |
12 | 14 | * Immutable Collections - array, list, vector, stream, set, map, finger tree, heterogenous list. |
13 | | -* Other Abstractions - monoid, semigroup, natural, random number generator, reader, writer, state, input/output, parser, zipper, specification based testing, actors, concurrency and type conversion. |
| 15 | +* Other Abstractions - monoid, semigroup, natural, random number generator, reader, writer, state, input/output, parser, zipper, specification based testing (quickcheck), actors, optics (lens, prism, fold, traversal and others), concurrency and type conversion. |
14 | 16 |
|
15 | 17 | == URLs |
16 | 18 |
|
17 | 19 | Important URLs for the project are: |
18 | 20 |
|
19 | 21 | * Website, http://www.functionaljava.org |
20 | 22 | * Website repository, http://github.com/functionaljava/functionaljava.github.io |
| 23 | +* Travis continuous integration build, https://travis-ci.org/functionaljava/functionaljava |
| 24 | +* Sonatype Repository, https://oss.sonatype.org/content/groups/public/org/functionaljava/ |
| 25 | +* Jenkins Cloudbees CI build, https://functionaljava.ci.cloudbees.com |
21 | 26 |
|
22 | 27 | == Downloading |
23 | 28 |
|
24 | 29 | The recommended way to download and use the project is through your build tool. |
25 | 30 |
|
26 | | -The Functional Java artifact is published to Maven Central using the group `org.functionaljava` with two published artifacts: |
| 31 | +The Functional Java artifact is published to Maven Central using the group `org.functionaljava` with three published artifacts: |
27 | 32 |
|
28 | 33 | * the core library (`functionaljava`) |
29 | 34 | * Java 8 specific support (`functionaljava-java8`) |
| 35 | +* property based testing (`functionaljava-quickcheck`) |
30 | 36 |
|
31 | | -The latest version is `4.2`. This can be added to your Gradle project by adding the dependencies: |
| 37 | +The latest stable version is `4.4`. This can be added to your Gradle project by adding the dependencies: |
32 | 38 | ---- |
33 | | -compile "org.functionaljava:functionaljava:4.2" |
34 | | -compile "org.functionaljava:functionaljava-java8:4.2" |
| 39 | +compile "org.functionaljava:functionaljava:4.4" |
| 40 | +compile "org.functionaljava:functionaljava-java8:4.4" |
| 41 | +compile "org.functionaljava:functionaljava-quickcheck:4.4" |
35 | 42 | ---- |
36 | 43 |
|
37 | 44 | and in Maven: |
38 | 45 | ---- |
39 | 46 | <dependency> |
40 | 47 | <groupId>org.functionaljava</groupId> |
41 | 48 | <artifactId>functionaljava</artifactId> |
42 | | - <version>4.2</version> |
| 49 | + <version>4.4</version> |
43 | 50 | </dependency> |
44 | 51 | <dependency> |
45 | 52 | <groupId>org.functionaljava</groupId> |
46 | 53 | <artifactId>functionaljava-java8</artifactId> |
47 | | - <version>4.2</version> |
| 54 | + <version>4.4</version> |
| 55 | +</dependency> |
| 56 | +<dependency> |
| 57 | + <groupId>org.functionaljava</groupId> |
| 58 | + <artifactId>functionaljava-quickcheck</artifactId> |
| 59 | + <version>4.4</version> |
48 | 60 | </dependency> |
49 | 61 | ---- |
50 | 62 |
|
51 | 63 | == Building |
52 | 64 |
|
53 | 65 | FunctionalJava uses the Retro Lambda project to backport Java 8 lambdas to Java 7 bytecode. This requires access to both JDK 7 and 8. The build system requires the environment variables `JAVA7_HOME` and `JAVA8_HOME` to refer to the appropriate directories. |
54 | 66 |
|
55 | | -Building is done using Gradle 2.2.1. In the root directory run: |
| 67 | +Building is done using Gradle 2.4. In the root directory run: |
56 | 68 | ---- |
57 | 69 | ./gradlew |
58 | 70 | ---- |
59 | | -This will download the Gradle build tool and necessary dependencies and build FunctionalJava. |
| 71 | +This requires access to Java and will download the Gradle build tool and necessary dependencies and build FunctionalJava. |
60 | 72 |
|
61 | 73 | == Features |
62 | 74 |
|
@@ -95,7 +107,8 @@ A more complete description of the features mentioned above are: |
95 | 107 | ** Zipper implementations for streams and trees. |
96 | 108 | ** Automated specification-based testing framework (`fj.test`). |
97 | 109 | ** Fully operational Actors for parallel computations (`fj.control.parallel`) and layered abstractions such as parallel-map, map-reduce, parallel-zip. |
| 110 | +** Optics for updating immutable data including lens, prism, iso, optional, traversal, getter, fold and setter. Inspired by the Scala Monocle library (https://github.com/julien-truffaut/Monocle) and the Haskell lens library (https://github.com/ekmett/lens). |
98 | 111 |
|
99 | 112 | == License |
100 | 113 |
|
101 | | -link:etc/LICENCE[The Functional Java license] uses the BSD 3 license (3-clause license) available at https://en.wikipedia.org/wiki/BSD_licenses[]. |
| 114 | +link:etc/LICENCE[The Functional Java license] uses the BSD 3 license (3-clause license) available at https://en.wikipedia.org/wiki/BSD_licenses[]. |
0 commit comments