Updated docs to Vavr 0.9.0

Author: danieldietrich

README.adoc

@@ -1,6 +1,6 @@
-= Javaslang Documentation
+= Vavr Documentation
 
-This is the source of the http://docs.javaslang.io/[Javaslang documentation].
+This is the source of the http://docs.vavr.io/[Vavr documentation].
 
 === Performing Updates
 
@@ -10,5 +10,5 @@ This is the source of the http://docs.javaslang.io/[Javaslang documentation].
   githubPassword=<GitHub password>
 
 * Update the version in `gradle.properties`. Please note that the version in the Maven section of `getting_started.adoc` currently has to be updated manually.
-* Write documentation and test results with `./gradlew asciidoc`. If the Javaslang API has changed, some code example tests might fail.
+* Write documentation and test results with `./gradlew asciidoc`. If the Vavr API has changed, some code example tests might fail.
 * Then `git commit`, `git push` and `./gradlew publishGhPages`

build.gradle

@@ -28,7 +28,7 @@ repositories {
 }
 
 dependencies {
-    testCompile "io.javaslang:javaslang:${project.version}"
+    testCompile "io.vavr:vavr:${project.version}"
     testCompile "junit:junit:4.11"
     testCompile "org.assertj:assertj-core:3.0.0"
     testCompile "ch.qos.logback:logback-classic:0.9.26"
@@ -73,7 +73,7 @@ copyCNAME.dependsOn asciidoctor
 publishGhPages.dependsOn copyCNAME
 
 githubPages {
-    repoUri = 'https://github.com/javaslang/javaslang-docs.git'
+    repoUri = 'https://github.com/vavr-io/vavr-docs.git'
 
     credentials {
         username = project.githubUser

gradle.properties

@@ -4,6 +4,6 @@ gradleGitVersion=1.3.2
 gradleWatchPluginVersion=0.1.5
 livereloadGradlePluginVersion=0.2.1
 
-description = Javaslang Documentation
-version = 2.0.5
-group = io.javaslang
+description = Vavr Documentation
+version = 0.9.0
+group = io.vavr

src/docs/asciidoc/getting_started.adoc

@@ -1,16 +1,16 @@
 == Getting started
 
-Projects that include Javaslang need to target Java 1.8 at minimum.
+Projects that include Vavr need to target Java 1.8 at minimum.
 
-The .jar is available at http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22javaslang%22%20g%3A%22io.javaslang%22[Maven Central].
+The .jar is available at http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.vavr%22%20a%3A%22vavr%22[Maven Central].
 
 === Gradle
 
 [source,groovy]
 [subs="attributes"]
 ----
 dependencies {
-    compile "io.javaslang:javaslang:{project-version}"
+    compile "io.vavr:vavr:{project-version}"
 }
 ----
 
@@ -20,20 +20,20 @@ dependencies {
 ----
 <dependencies>
     <dependency>
-        <groupId>io.javaslang</groupId>
-        <artifactId>javaslang</artifactId>
-        <version>2.0.5</version>
+        <groupId>io.vavr</groupId>
+        <artifactId>vavr</artifactId>
+        <version>0.9.0</version>
     </dependency>
 </dependencies>
 ----
 
 === Standalone
 
-Because Javaslang does __not__ depend on any libraries (other than the JVM) you can easily add it as standalone .jar to your classpath.
+Because Vavr does __not__ depend on any libraries (other than the JVM) you can easily add it as standalone .jar to your classpath.
 
 === Snapshots
 
-Developer versions can be found https://oss.sonatype.org/content/repositories/snapshots/io/javaslang/javaslang[here].
+Developer versions can be found https://oss.sonatype.org/content/repositories/snapshots/io/vavr/vavr[here].
 
 ==== Gradle
 

src/docs/asciidoc/images/javaslang-collections.png renamed to src/docs/asciidoc/images/vavr-collections.png

@@ -1,4 +1,4 @@
-= Javaslang User Guide
+= Vavr User Guide
 Daniel Dietrich, Robert Winkler
 :toc: left
 :toclevels: 3

src/docs/asciidoc/images/javaslang-overview.png renamed to src/docs/asciidoc/images/vavr-overview.png

@@ -1,20 +1,20 @@
 == Introduction
 
-Javaslang is a functional library for Java 8+ that provides persistent data types and functional control structures.
+Vavr is a functional library for Java 8+ that provides persistent data types and functional control structures.
 
-=== Functional Data Structures in Java 8 with Javaslang
+=== Functional Data Structures in Java 8 with Vavr
 
 Java 8’s https://docs.oracle.com/javase/tutorial/java/javaOO/lambdaexpressions.html[lambdas (λ)] empower us to create wonderful API’s. They incredibly increase the expressiveness of the language.
 
-http://javaslang.io/[Javaslang] leveraged lambdas to create various new features based on functional patterns. One of them is a functional collection library that is intended to be a replacement for Java’s standard collections.
+http://vavr.io/[Vavr] leveraged lambdas to create various new features based on functional patterns. One of them is a functional collection library that is intended to be a replacement for Java’s standard collections.
 
-image::images/javaslang-collections.png[Javaslang Collections]
+image::images/vavr-collections.png[Vavr Collections]
 
 __(This is just a bird’s view, you will find a human-readable version below.)__
 
 === Functional Programming
 
-Before we deep-dive into the details about the data structures I want to talk about some basics. This will make it clear why I created Javaslang and specifically new Java collections.
+Before we deep-dive into the details about the data structures I want to talk about some basics. This will make it clear why I created Vavr and specifically new Java collections.
 
 ==== Side-Effects
 
@@ -70,11 +70,11 @@ Rich Hickey, the creator of Clojure, gave a great talk about https://www.youtube
 *   behave type-safe when used in unchecked covariant casts (Java-specific)
 The key to a better Java is to use __immutable values__ paired with __referentially transparent functions__.
 
-Javaslang provides the necessary http://static.javadoc.io/io.javaslang/javaslang/2.0.0/javaslang/control/package-summary.html[controls] and http://static.javadoc.io/io.javaslang/javaslang/2.0.0/javaslang/collection/package-summary.html[collections] to accomplish this goal in every-day Java programming.
+Vavr provides the necessary http://static.javadoc.io/io.vavr/vavr/0.9.0/io/vavr/control/package-summary.html[controls] and https://static.javadoc.io/io.vavr/vavr/0.9.0/io/vavr/collection/package-summary.html[collections] to accomplish this goal in every-day Java programming.
 
 === Data Structures in a Nutshell
 
-Javaslang’s collection library comprises of a rich set of functional data structures built on top of lambdas. The only interface they share with Java’s original collections is Iterable. The main reason is that the mutator methods of Java’s collection interfaces do not return an object of the underlying collection type.
+Vavr’s collection library comprises of a rich set of functional data structures built on top of lambdas. The only interface they share with Java’s original collections is Iterable. The main reason is that the mutator methods of Java’s collection interfaces do not return an object of the underlying collection type.
 
 We will see why this is so essential by taking a look at the different types of data structures.
 
@@ -120,13 +120,13 @@ This model does not impose any implementation details. Here come functional data
 
 Also known as https://en.wikipedia.org/wiki/Purely_functional[__purely__ functional data structures], these are __immutable__ and __persistent__. The methods of functional data structures are __referentially transparent__.
 
-Javaslang features a wide range of the most-commonly used functional data structures. The following examples are explained in-depth.
+Vavr features a wide range of the most-commonly used functional data structures. The following examples are explained in-depth.
 
 ==== Linked List
 
 One of the most popular and also simplest functional data structures is the https://en.wikipedia.org/wiki/Linked_list[(singly) linked List]. It has a __head__ element and a __tail__ List. A linked List behaves like a Stack which follows the https://en.wikipedia.org/wiki/Stack_(abstract_data_type)[last in, first out (LIFO)] method.
 
-In http://javaslang.io/[Javaslang] we instantiate a List like this:
+In http://vavr.io/[Vavr] we instantiate a List like this:
 
 [source,java]
 ----
@@ -150,9 +150,9 @@ The new head element 0 is __linked__ to the tail of the original List. The origi
 
 image::images/list2.png?w=660[List 2]
 
-These operations take place in constant time, in other words they are independent of the List size. Most of the other operations take linear time. In Javaslang this is expressed by the interface LinearSeq, which we may already know from Scala.
+These operations take place in constant time, in other words they are independent of the List size. Most of the other operations take linear time. In Vavr this is expressed by the interface LinearSeq, which we may already know from Scala.
 
-If we need data structures that are queryable in constant time, Javaslang offers Array and Vector. Both have https://en.wikipedia.org/wiki/Random_access[random access] capabilities.
+If we need data structures that are queryable in constant time, Vavr offers Array and Vector. Both have https://en.wikipedia.org/wiki/Random_access[random access] capabilities.
 
 The Array type is backed by a Java array of objects. Insert and remove operations take linear time. Vector is in-between Array and List. It performs well in both areas, random access and modification.
 
@@ -256,7 +256,7 @@ image::images/binarytree2.png?w=660[Binary Tree 2]
 
 In order to maintain the performance characteristics of a binary search tree it needs to be kept balanced. All paths from the root to a leaf need to have roughly the same length.
 
-In Javaslang we implemented a binary search tree based on a https://en.wikipedia.org/wiki/Red%E2%80%93black_tree[Red/Black Tree]. It uses a specific coloring strategy to keep the tree balanced on inserts and deletes. To read more about this topic please refer to the book http://www.amazon.com/Purely-Functional-Structures-Chris-Okasaki/dp/0521663504[Purely Functional Data Structures] by Chris Okasaki.
+In Vavr we implemented a binary search tree based on a https://en.wikipedia.org/wiki/Red%E2%80%93black_tree[Red/Black Tree]. It uses a specific coloring strategy to keep the tree balanced on inserts and deletes. To read more about this topic please refer to the book http://www.amazon.com/Purely-Functional-Structures-Chris-Okasaki/dp/0521663504[Purely Functional Data Structures] by Chris Okasaki.
 
 === State of the Collections
 
@@ -285,15 +285,15 @@ Arrays.asList(1, 2, 3)
       .collect(Collectors.toList())
 ----
 
-Javaslang is greatly inspired by Scala. This is how the above example should have been in Java 8.
+Vavr is greatly inspired by Scala. This is how the above example should have been in Java 8.
 
 [source,java]
 ----
-// = Stream("1", "2", "3") in Javaslang
+// = Stream("1", "2", "3") in Vavr
 Stream.of(1, 2, 3).map(Object::toString)
 ----
 
-Within the last year we put much effort into implementing the Javaslang collection library. It comprises the most widely used collection types.
+Within the last year we put much effort into implementing the Vavr collection library. It comprises the most widely used collection types.
 
 ==== Seq
 
@@ -335,7 +335,7 @@ String join(String... words) {
 }
 ----
 
-The Javaslang collections provide us with many functions to operate on the underlying elements. This allows us to express things in a very concise way.
+The Vavr collections provide us with many functions to operate on the underlying elements. This allows us to express things in a very concise way.
 
 [source,java]
 ----
@@ -346,7 +346,7 @@ String join(String... words) {
 }
 ----
 
-Most goals can be accomplished in various ways using Javaslang. Here we reduced the whole method body to fluent function calls on a List instance. We could even remove the whole method and directly use our List to obtain the computation result.
+Most goals can be accomplished in various ways using Vavr. Here we reduced the whole method body to fluent function calls on a List instance. We could even remove the whole method and directly use our List to obtain the computation result.
 
 [source,java]
 ----
@@ -365,7 +365,7 @@ We described how to model sorted Sets with binary tree structures. A sorted Map
 
 The HashMap implementation is backed by a http://lampwww.epfl.ch/papers/idealhashtrees.pdf[Hash Array Mapped Trie (HAMT)]. Accordingly the HashSet is backed by a HAMT containing key-key pairs.
 
-Our Map does __not__ have a special Entry type to represent key-value pairs. Instead we use Tuple2 which is already part of Javaslang. The fields of a Tuple are enumerated.
+Our Map does __not__ have a special Entry type to represent key-value pairs. Instead we use Tuple2 which is already part of Vavr. The fields of a Tuple are enumerated.
 
 [source,java]
 ----
@@ -376,7 +376,7 @@ Integer key = entry._1;
 String value = entry._2;
 ----
 
-Maps and Tuples are used throughout Javaslang. Tuples are inevitable to handle multi-valued return types in a general way.
+Maps and Tuples are used throughout Vavr. Tuples are inevitable to handle multi-valued return types in a general way.
 
 [source,java]
 ----
@@ -387,4 +387,4 @@ List.of(1, 2, 3, 4).groupBy(i -> i % 2);
 List.of('a', 'b', 'c').zipWithIndex();
 ----
 
-At Javaslang, we explore and test our library by implementing the https://projecteuler.net/archives[99 Euler Problems]. It is a great proof of concept. Please don’t hesitate to send pull requests.
+At Vavr, we explore and test our library by implementing the https://projecteuler.net/archives[99 Euler Problems]. It is a great proof of concept. Please don’t hesitate to send pull requests.

src/docs/asciidoc/index.adoc

@@ -1,6 +1,6 @@
 == License
 
-Copyright 2014-2016 Javaslang, http://javaslang.io
+Copyright 2014-2016 Vavr, http://vavr.io
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.