<html lang="en">

<head>

<title>

Functional Java

- Documentation

</title>

<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<meta name="author" content="Functional Java">

<meta name="description" content="Static blog generated with JBake">

<!-- Style -->

<link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootswatch/3.1.1/yeti/bootstrap.min.css">

<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.css">

<link rel="stylesheet" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css">

<link rel="stylesheet" href="/css/base.css">

<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->

<!--[if lt IE 9]>

<!-- Fav icon -->

<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">

<link rel="icon" href="/img/favicon.ico" type="image/x-icon">

</head>

<body>

<nav class="navbar navbar-default navbar-fixed-top " role="navigation">

<div class="container">

<!-- Brand and toggle get grouped for better mobile display -->

<div class="navbar-header">

<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">

<span class="sr-only">Toggle navigation</span>

<span class="icon-bar"></span>

<span class="icon-bar"></span>

<span class="icon-bar"></span>

</button>

<a class="navbar-brand" href="/"><img src="/img/white-lambda6.png" height="20"/>&nbsp;Functional Java</a>

</div>

<!-- Collect the nav links, forms, and other content for toggling -->

<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">

<ul class="nav navbar-nav">

<li><a href="/docs.html">Docs</a></li>

<li><a href="/community.html">Community</a></li>

<li><a href="/download.html">Download</a></li>

</ul>

<!-- Right navigation -->

<ul class="nav navbar-nav navbar-right">

<li><a href="/feed.xml" title="Rss"><i class="fa fa-rss"></i> Feed</a></li>

</ul>

<!-- Right navigation end -->

</div><!-- /.navbar-collapse -->

</div><!-- /.container-fluid -->

</nav><!-- /.navbar -->

<!-- Begin page content -->

<div class="container">

<div class="row">

<div class="col-md-12">

<article>

<h2>Documentation</h2>

<p><div class="sect1">

<h2 id="_learn">Learn</h2>

<div class="sectionbody">

<div class="ulist">

<ul>

<li> <p><a href="quickstart.html">Quickstart Guide</a> - How to include Functional Java in your project and get started</p> </li>

<li> <p><a href="features.html">Features List</a> - Brief overview of Functional Java features</p> </li>

</ul>

</div>

</div>

</div>

<div class="sect1">

<h2 id="_examples">Examples</h2>

<div class="sectionbody">

<div class="paragraph">

<p>There are numerous examples of using FunctionalJava:</p>

</div>

<div class="ulist">

<ul>

<li> <p><a href="examples-java8.html">Java 8 Examples</a></p> </li>

<li> <p><a href="examples-java7.html">Java 7 Examples</a></p> </li>

<li> <p><a href="examples-bgga.html">Obsolete BGGA Proposal Examples</a></p> </li>

</ul>

</div>

</div>

</div>

<div class="sect1">

<h2 id="_release_notes">Release Notes</h2>

<div class="sectionbody">

<div class="paragraph">

<p>Release notes are available from the <a href="download.html">download page</a>. Alternately you can use the <a href="https://github.com/functionaljava/functionaljava/blob/master/etc/release-notes/">index of release notes</a>.</p>

</div>

</div>

</div>

<div class="sect1">

<h2 id="_javadoc">Javadoc</h2>

<div class="sectionbody">

<div class="sect2">

<h3 id="_5_0">5.0</h3>

<div class="ulist">

<ul>

<li> <p><a href="http://www.functionaljava.org/javadoc/5.0/functionaljava/index.html">5.0 - functionaljava</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/5.0/functionaljava-quickcheck/index.html">5.0 - functionaljava-quickcheck</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/5.0/functionaljava-java-core/index.html">5.0 - functionaljava-java-core</a></p> </li>

</ul>

</div>

</div>

<div class="sect2">

<h3 id="_4_9">4.9</h3>

<div class="paragraph">

<p>TODO</p>

</div>

</div>

<div class="sect2">

<h3 id="_4_8_1">4.8.1</h3>

<div class="ulist">

<ul>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.8.1/functionaljava/index.html">4.8.1 - functionaljava</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.8.1/functionaljava-java8/index.html">4.8.1 - functionaljava-java8</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.8.1/functionaljava-quickcheck/index.html">4.8.1 - functionaljava-quickcheck</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.8.1/functionaljava-java-core/index.html">4.8.1 - functionaljava-java-core</a></p> </li>

</ul>

</div>

</div>

<div class="sect2">

<h3 id="_4_8">4.8</h3>

<div class="ulist">

<ul>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.8/functionaljava/index.html">4.8 - functionaljava</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.8/functionaljava-java8/index.html">4.8 - functionaljava-java8</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.8/functionaljava-quickcheck/index.html">4.8 - functionaljava-quickcheck</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.8/functionaljava-java-core/index.html">4.8 - functionaljava-java-core</a></p> </li>

</ul>

</div>

</div>

<div class="sect2">

<h3 id="_4_7">4.7</h3>

<div class="ulist">

<ul>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.7/functionaljava/index.html">4.7 - functionaljava</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.7/functionaljava-java8/index.html">4.7 - functionaljava-java8</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.7/functionaljava-quickcheck/index.html">4.7 - functionaljava-quickcheck</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.7/functionaljava-java-core/index.html">4.7 - functionaljava-java-core</a></p> </li>

</ul>

</div>

</div>

<div class="sect2">

<h3 id="_4_6">4.6</h3>

<div class="ulist">

<ul>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.6/functionaljava/index.html">4.6 - functionaljava</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.6/functionaljava-java8/index.html">4.6 - functionaljava-java8</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.6/functionaljava-quickcheck/index.html">4.6 - functionaljava-quickcheck</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.6/functionaljava-java-core/index.html">4.6 - functionaljava-java-core</a></p> </li>

</ul>

</div>

</div>

<div class="sect2">

<h3 id="_4_5">4.5</h3>

<div class="ulist">

<ul>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.5/functionaljava/index.html">4.5 - functionaljava</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.5/functionaljava-java8/index.html">4.5 - functionaljava-java8</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.5/functionaljava-quickcheck/index.html">4.5 - functionaljava-quickcheck</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.5/functionaljava-java-core/index.html">4.5 - functionaljava-java-core</a></p> </li>

</ul>

</div>

</div>

<div class="sect2">

<h3 id="_4_4">4.4</h3>

<div class="ulist">

<ul>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.4/functionaljava/index.html">4.4 - functionaljava</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.4/functionaljava-java8/index.html">4.4 - functionaljava-java8</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.4/functionaljava-quickcheck/index.html">4.4 - functionaljava-quickcheck</a></p> </li>

</ul>

</div>

</div>

<div class="sect2">

<h3 id="_others">Others</h3>

<div class="ulist">

<ul>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.3/functionaljava/index.html">4.3 - functionaljava</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.3/functionaljava-java8/index.html">4.3 - functionaljava-java8</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.2/functionaljava/index.html">4.2 - functionaljava</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.2/functionaljava-java8/index.html">4.2 - functionaljava-java8</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.1/index.html">4.1</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/4.0/index.html">4.0</a></p> </li>

<li> <p><a href="https://functionaljava.ci.cloudbees.com/job/3.x/javadoc/">Latest 3.x (currently 3.3-SNAPSHOT)</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/3.2/index.html">3.2</a></p> </li>

<li> <p><a href="http://www.functionaljava.org/javadoc/3.1/index.html">3.1</a></p> </li>

<li> <p><a href="https://functionaljava.googlecode.com/svn/artifacts/3.0/javadoc/index.html">3.0</a></p> </li>

<li> <p><a href="https://functionaljava.googlecode.com/svn/artifacts/2.23/javadoc/index.html">2.23</a></p> </li>

<li> <p><a href="https://functionaljava.googlecode.com/svn/artifacts/2.22/javadoc/index.html">2.22</a></p> </li>

<li> <p><a href="https://functionaljava.googlecode.com/svn/artifacts/2.21/javadoc/index.html">2.21</a></p> </li>

</ul>

</div>

</div>

</div>

</div>

<div class="sect1">

<h2 id="_building">Building</h2>

<div class="sectionbody">

<div class="paragraph">

<p>FunctionalJava 5.x uses Java 8. Future releases will follow the Java long term support model, the future series 6.x uses Java 11 and 7.x uses Java 17.</p>

</div>

<div class="paragraph">

<p>The FunctionalJava 4.x series uses the Retro Lambda project to backport Java 8 lambdas to Java 6 bytecode. This requires access to both JDK 6 and 8. The build system requires the environment variables <code>JAVA6_HOME</code> and <code>JAVA8_HOME</code> to refer to the appropriate directories.</p>

</div>

<div class="paragraph">

<p>Building is done using Gradle. In the root directory run:</p>

</div>

<div class="listingblock">

<div class="content">

<pre>./gradlew</pre>

</div>

</div>

<div class="paragraph">

<p>This will download the Gradle build tool and necessary dependencies and build FunctionalJava.</p>

</div>

</div>

</div>

<div class="sect1">

<h2 id="_license">License</h2>

<div class="sectionbody">

<div class="paragraph">

<p><a href="http://github.com/functionaljava/functionaljava/blob/master/etc/LICENCE">Functional Java is licensed</a> under the BSD 3 license, available at (3-clause license, <a href="https://en.wikipedia.org/wiki/BSD_licenses" class="bare">https://en.wikipedia.org/wiki/BSD_licenses</a>).</p>

</div>

</div>

</article>

</div> <!-- /.col-md-12 -->

</div> <!-- /.row -->

</div><!-- /.container -->

<footer>

<div class="container">

<hr>

<div class="row">

<div class="col-xs-10">

<p class="text-muted credit">&copy; 2014-2018 | Mixed with <a href="http://getbootstrap.com/">Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org">JBake v2.6.1</a> | <i title="Linux" class="fa fa-linux"></i></p>

</div>

<div class="col-xs-2 gotop">

<a href="#"><i class="fa fa-arrow-circle-up"> top</i></a>

</div>

</div>

</div>

</footer>

<!-- Placed at the end of the document so the pages load faster -->

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>

<script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>

<script src="//cdnjs.cloudflare.com/ajax/libs/gist-embed/1.6/gist-embed.min.js"></script>

<script>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-28753951-2', 'auto');

ga('send', 'pageview');

</script>

<script src="//cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.js"></script>

<script type="text/javascript">

<!-- load prettify only when needed -->

$(document).ready(function(){

var prettify = false;

var classToAdd = 'prettyprint snippet';

$("pre > code").each(function() {

$("pre > code").parent().addClass(classToAdd);

prettify = true;

});

if(prettify) {

prettyPrint();

}

});

</script>

</body>