diff --git a/build.gradle b/build.gradle
index ceb2f93..007454d 100644
--- a/build.gradle
+++ b/build.gradle
@@ -79,12 +79,12 @@ asciidoctor {
}
}
-tasks.register('asciidoc_pl', AsciidoctorTask) {
+tasks.register('asciidoc_es', AsciidoctorTask) {
group = 'documentation'
- description = 'Generates documentation for the "pl" directory.'
+ description = 'Generates documentation for the "es" directory.'
- sourceDir = file('src/docs/asciidoc/pl')
- outputDir = file("$buildDir/docs/asciidoc/pl")
+ sourceDir = file('src/docs/asciidoc/es')
+ outputDir = file("$buildDir/docs/asciidoc/es")
options backend: 'html5'
@@ -114,7 +114,7 @@ tasks.register('copyCNAME', Copy) {
into file(asciidoctor.outputDir.path)
}
-asciidoctor.dependsOn asciidoc_pl
+asciidoctor.dependsOn asciidoc_es
copyCNAME.dependsOn asciidoctor
publishGhPages.dependsOn copyCNAME
diff --git a/src/docs/asciidoc/pl/getting_started.adoc b/src/docs/asciidoc/es/getting_started.adoc
similarity index 63%
rename from src/docs/asciidoc/pl/getting_started.adoc
rename to src/docs/asciidoc/es/getting_started.adoc
index 47b39ae..4271889 100644
--- a/src/docs/asciidoc/pl/getting_started.adoc
+++ b/src/docs/asciidoc/es/getting_started.adoc
@@ -1,8 +1,8 @@
-== Getting started
+== Comenzando
-Projects that include Vavr need to target Java 1.8 at minimum.
+Los proyectos que incluyan Vavr deben apuntar como mínimo a Java 1.8.
-The .jar is available at http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.vavr%22%20a%3A%22vavr%22[Maven Central].
+El archivo `.jar` está disponible en http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.vavr%22%20a%3A%22vavr%22[Maven Central].
=== Gradle
@@ -32,22 +32,22 @@ dependencies {
io.vavr
vavr
- 0.10.5
+ 0.10.4
----
-=== Standalone
+=== Independiente
-Because Vavr does __not__ depend on any libraries (other than the JVM) you can easily add it as standalone .jar to your classpath.
+Debido a que Vavr __no__ depende de ninguna biblioteca (aparte de la JVM), puedes agregarlo fácilmente como un archivo `.jar` independiente a tu __classpath__.
=== Snapshots
-Developer versions can be found https://oss.sonatype.org/content/repositories/snapshots/io/vavr/vavr[here].
+Las versiones en desarrollo se pueden encontrar https://oss.sonatype.org/content/repositories/snapshots/io/vavr/vavr[aquí].
==== Gradle
-Add the additional snapshot repository to your `build.gradle`:
+Agrega el repositorio adicional de snapshots en tu archivo `build.gradle`:
[source,groovy]
----
@@ -59,7 +59,7 @@ repositories {
==== Maven
-Ensure that your ``~/.m2/settings.xml`` contains the following:
+Asegúrate de que tu archivo ``~/.m2/settings.xml`` contenga lo siguiente:
[source,xml]
----
diff --git a/src/docs/asciidoc/pl/images/binarytree1.png b/src/docs/asciidoc/es/images/binarytree1.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/binarytree1.png
rename to src/docs/asciidoc/es/images/binarytree1.png
diff --git a/src/docs/asciidoc/pl/images/binarytree2.png b/src/docs/asciidoc/es/images/binarytree2.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/binarytree2.png
rename to src/docs/asciidoc/es/images/binarytree2.png
diff --git a/src/docs/asciidoc/pl/images/collections-seq.png b/src/docs/asciidoc/es/images/collections-seq.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/collections-seq.png
rename to src/docs/asciidoc/es/images/collections-seq.png
diff --git a/src/docs/asciidoc/pl/images/collections-set-map.png b/src/docs/asciidoc/es/images/collections-set-map.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/collections-set-map.png
rename to src/docs/asciidoc/es/images/collections-set-map.png
diff --git a/src/docs/asciidoc/pl/images/list1.png b/src/docs/asciidoc/es/images/list1.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/list1.png
rename to src/docs/asciidoc/es/images/list1.png
diff --git a/src/docs/asciidoc/pl/images/list2.png b/src/docs/asciidoc/es/images/list2.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/list2.png
rename to src/docs/asciidoc/es/images/list2.png
diff --git a/src/docs/asciidoc/pl/images/queue1.png b/src/docs/asciidoc/es/images/queue1.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/queue1.png
rename to src/docs/asciidoc/es/images/queue1.png
diff --git a/src/docs/asciidoc/pl/images/queue2.png b/src/docs/asciidoc/es/images/queue2.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/queue2.png
rename to src/docs/asciidoc/es/images/queue2.png
diff --git a/src/docs/asciidoc/pl/images/vavr-collections.png b/src/docs/asciidoc/es/images/vavr-collections.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/vavr-collections.png
rename to src/docs/asciidoc/es/images/vavr-collections.png
diff --git a/src/docs/asciidoc/pl/images/vavr-overview.png b/src/docs/asciidoc/es/images/vavr-overview.png
similarity index 100%
rename from src/docs/asciidoc/pl/images/vavr-overview.png
rename to src/docs/asciidoc/es/images/vavr-overview.png
diff --git a/src/docs/asciidoc/pl/index.adoc b/src/docs/asciidoc/es/index.adoc
similarity index 83%
rename from src/docs/asciidoc/pl/index.adoc
rename to src/docs/asciidoc/es/index.adoc
index f33a75d..b423293 100644
--- a/src/docs/asciidoc/pl/index.adoc
+++ b/src/docs/asciidoc/es/index.adoc
@@ -1,5 +1,6 @@
-= Vavr Dokumentacja Techniczna
+= Guía del usuario de Vavr
Daniel Dietrich, Robert Winkler, Grzegorz Piwowarek
+translation: traducido por Geovanny Mendoza
:toc: left
:toclevels: 3
:source-highlighter: coderay
diff --git a/src/docs/asciidoc/es/introduction.adoc b/src/docs/asciidoc/es/introduction.adoc
new file mode 100644
index 0000000..4432157
--- /dev/null
+++ b/src/docs/asciidoc/es/introduction.adoc
@@ -0,0 +1,392 @@
+== Introducción
+
+Vavr (anteriormente conocido como Javaslang) es una biblioteca funcional para Java 8+ que ofrece tipos de datos persistentes y estructuras de control funcionales.
+
+=== Estructuras de Datos Funcionales en Java 8 con Vavr
+
+Las https://docs.oracle.com/javase/tutorial/java/javaOO/lambdaexpressions.html[lambdas (λ)] de Java 8 nos permiten crear API maravillosas. Incrementan increíblemente la expresividad del lenguaje.
+
+http://vavr.io/[Vavr] aprovechó las lambdas para introducir diversas características nuevas basadas en patrones funcionales. Una de ellas es una biblioteca de colecciones funcionales diseñada como un reemplazo para las colecciones estándar de Java.
+
+image::images/vavr-collections.png[Vavr Collections]
+
+__(Esta es solo una vista general; encontrarás una versión más detallada y legible a continuación.)__
+
+=== Programación Funcional
+
+Antes de profundizar en los detalles sobre las estructuras de datos, quiero hablar sobre algunos conceptos básicos. Esto ayudará a entender por qué se creó *Vavr* y, en particular, por qué nuevas colecciones en Java eran necesarias.
+
+==== Efectos Secundarios
+
+Las aplicaciones Java suelen estar llenas de https://en.wikipedia.org/wiki/Side_effect_(computer_science)[side-effects]. Estos mutan algún tipo de estado, tal vez el mundo exterior. Los efectos secundarios comunes incluyen cambiar objetos o variables __en el lugar__, imprimir en la consola, escribir en un archivo de registro o en una base de datos. Los efectos secundarios se consideran __perjudiciales__ si afectan la semántica de nuestro programa de manera no deseada.
+
+Por ejemplo, si una función lanza una excepción y esta excepción es __interpretada__, se considera un efecto secundario que __afecta nuestro programa__. Además, http://c2.com/cgi/wiki?DontUseExceptionsForFlowControl[las excepciones son como declaraciones goto no locales]. Rompen el flujo de control normal. Sin embargo, las aplicaciones del mundo real realizan efectos secundarios.
+
+[source,java]
+----
+int divide(int dividend, int divisor) {
+ // lanza una excepción si divisor es cero
+ return dividend / divisor;
+}
+
+----
+
+En un entorno funcional, estamos en la situación favorable de encapsular el efecto secundario en un `Try`:
+
+[source,java]
+----
+// = Success(result) o Failure(exception)
+Try divide(Integer dividend, Integer divisor) {
+ return Try.of(() -> dividend / divisor);
+}
+
+----
+
+Esta versión de `divide` ya no lanza ninguna excepción. Hicimos que el posible fallo sea explícito al usar el tipo `Try`
+
+==== Transparencia Referencial
+
+Una función, o más generalmente una expresión, se denomina https://en.wikipedia.org/wiki/Referential_transparency[referencialmente transparente] si una llamada puede ser reemplazada por su valor sin afectar el comportamiento del programa. Dicho de manera sencilla, dado el mismo input, la salida siempre será la misma.
+
+[source,java]
+----
+// no es referencialmente transparente
+Math.random();
+
+// referencialmente transparente
+Math.max(1, 2);
+
+----
+
+Una función se llama https://en.wikipedia.org/wiki/Pure_function[pura] si todas las expresiones involucradas son referencialmente transparentes. Una aplicación compuesta por funciones puras probablemente simplemente funcione si compila. Podemos razonar sobre ella. Las pruebas unitarias son fáciles de escribir y la depuración se convierte en un vestigio del pasado.
+
+==== Pensar en Valores
+
+Rich Hickey, el creador de Clojure, dio una charla excepcional sobre https://www.youtube.com/watch?v=-6BsiVyC1kM[El Valor de los Valores]. Los valores más interesantes son los valores https://en.wikipedia.org/wiki/Immutable_object[immutable]. La razón principal es que los valores inmutables:
+
+* Son intrínsecamente seguros para hilos y, por lo tanto, no necesitan sincronización.
+* Son estables en relación con __equals__ and __hashCode__, lo que los convierte en claves de hash confiables.
+* No necesitan ser clonados.
+* Se comportan de manera segura con tipos al usarse en conversiones covariantes no verificadas (específicas de Java).
+
+La clave para mejorar Java es usar __valores inmutables__ junto con __funciones referencialmente transparentes__.
+
+Vavr proporciona los http://static.javadoc.io/io.vavr/vavr/0.10.4/io/vavr/control/package-summary.html[controles] y las https://static.javadoc.io/io.vavr/vavr/0.10.4/io/vavr/collection/package-summary.html[colecciones] necesarios para lograr este objetivo en la programación cotidiana en Java.
+
+=== Estructuras de Datos en Resumen
+
+La biblioteca de colecciones de Vavr incluye un conjunto rico de estructuras de datos funcionales construidas sobre lambdas. La única interfaz que comparten con las colecciones originales de Java es `Iterable`. La razón principal es que los métodos mutadores de las interfaces de colecciones de Java no devuelven un objeto del tipo de colección subyacente.
+
+Veremos por qué esto es esencial observando los diferentes tipos de estructuras de datos.
+
+==== Estructuras de Datos Mutables
+
+Java es un lenguaje de programación orientado a objetos. Encapsulamos el estado en objetos para lograr ocultar los datos y proporcionamos métodos mutadores para controlar dicho estado. El https://en.wikipedia.org/wiki/Java_collections_framework[framework de colecciones de Java (JCF)] se basa en esta idea.
+
+[source,java]
+----
+interface Collection {
+ // elimina todos los elementos de esta colección
+ void clear();
+}
+
+----
+
+Hoy en día, considero que un tipo de retorno __void__ es un indicio de mal diseño. Es evidencia de que ocurren https://en.wikipedia.org/wiki/Side_effect_(computer_science)[efectos secundarios] y de que el estado se está mutando. El estado mutable __Shared__ es una fuente importante de fallos, no solo en un entorno concurrente.
+
+==== Estructuras de Datos Inmutables
+
+Las estructuras de datos https://en.wikipedia.org/wiki/Immutable_object[Immutables] no pueden modificarse después de su creación. En el contexto de Java, se utilizan ampliamente en forma de wrappers de colecciones.
+
+[source,java]
+----
+List list = Collections.unmodifiableList(otherList);
+
+// Boom!
+list.add("Por qué no?");
+
+----
+
+Existen varias bibliotecas que nos proporcionan métodos de utilidad similares. El resultado siempre es una vista no modificable de la colección específica. Por lo general, lanzará una excepción en tiempo de ejecución si llamamos a un método mutador.
+
+==== Estructuras de Datos Persistentes
+
+Una https://en.wikipedia.org/wiki/Persistent_data_structure[estructura de datos persistente] conserva la versión anterior de sí misma cuando se modifica, y por lo tanto es efectivamente inmutable. Las estructuras de datos completamente persistentes permiten tanto actualizaciones como consultas en cualquier versión.
+
+Muchas operaciones realizan solo pequeños cambios. Simplemente copiar la versión anterior no sería eficiente. Para ahorrar tiempo y memoria, es crucial identificar las similitudes entre dos versiones y compartir la mayor cantidad de datos posible.
+
+Este modelo no impone ningún detalle de implementación específico. Aquí es donde entran en juego las estructuras de datos funcionales.
+
+=== Estructuras de Datos Funcionales
+
+También conocidas como https://en.wikipedia.org/wiki/Purely_functional[estructuras de datos __puramente__ funcionales], son __inmutables__ y __persistentes__. Los métodos de las estructuras de datos funcionales son __referencialmente transparentes__.
+
+Vavr incluye una amplia gama de las estructuras de datos funcionales más utilizadas. Los siguientes ejemplos se explican en detalle.
+
+==== Linked List
+
+Una de las estructuras de datos funcionales más populares y también más simples es la lista enlazada https://en.wikipedia.org/wiki/Linked_list[(singly) linked List]. Esta estructura tiene un elemento principal __head__ y una lista __tail__ (cola). Una lista enlazada se comporta como una pila (Stack) que sigue el método https://en.wikipedia.org/wiki/Stack_(abstract_data_type)[último en entrar, primero en salir (LIFO)].
+
+En http://vavr.io/[Vavr], podemos instanciar una lista de la siguiente manera:
+
+[source,java]
+----
+// = List(1, 2, 3)
+List list1 = List.of(1, 2, 3);
+----
+
+Cada elemento de la lista forma un nodo separado de la lista. La cola (__tail__) del último elemento es `Nil`, que representa la lista vacía.
+
+image::images/list1.png?w=660[Lista 1]
+
+Esto nos permite compartir elementos entre diferentes versiones de la lista.
+
+[source,java]
+----
+// = List(0, 2, 3)
+List list2 = list1.tail().prepend(0);
+----
+
+El nuevo elemento principal `0` está __vinculado__ a la cola de la lista original. La lista original permanece sin modificar.
+
+image::images/list2.png?w=660[Lista 2]
+
+Estas operaciones se realizan en tiempo constante, es decir, son independientes del tamaño de la lista. La mayoría de las otras operaciones toman tiempo lineal. En Vavr, esto se expresa mediante la interfaz `LinearSeq`, que ya conocemos de Scala.
+
+Si necesitamos estructuras de datos que permitan consultas en tiempo constante, Vavr ofrece `Array` y `Vector`. Ambos tienen capacidades de https://en.wikipedia.org/wiki/Random_access[acceso aleatorio].
+
+El tipo `Array` está respaldado por un array de objetos de Java. Las operaciones de inserción y eliminación toman tiempo lineal. Él `Vector` está entre `Array` y `List`. Tiene un buen rendimiento tanto en acceso aleatorio como en modificaciones.
+
+De hecho, la lista enlazada también puede utilizarse para implementar una estructura de datos tipo cola (__Queue__).
+
+==== Queue
+
+Una cola funcional muy eficiente puede implementarse utilizando dos listas enlazadas. La lista __front__ contiene los elementos que se eliminan de la __cola__, mientras que la lista __rear__ contiene los elementos que se agregan. Ambas operaciones, `enqueue` y `dequeue`, se realizan en tiempo O(1).
+
+[source,java]
+----
+Queue queue = Queue.of(1, 2, 3)
+ .enqueue(4)
+ .enqueue(5);
+----
+
+La cola inicial se crea con tres elementos. Luego, se agregan dos elementos en la lista rear.
+
+image::images/queue1.png?w=660[Queue 1]
+
+Si la lista front se queda sin elementos al hacer `dequeue`, la lista __rear__ se invierte y se convierte en la nueva lista __front__.
+
+image::images/queue2.png?w=660[Queue 2]
+
+Al hacer `dequeue` de un elemento, obtenemos un par que incluye el primer elemento y la cola restante. Es necesario devolver la nueva versión de la cola porque las estructuras de datos funcionales son inmutables y persistentes. La cola original no se ve afectada.
+
+[source,java]
+----
+Queue queue = Queue.of(1, 2, 3);
+
+// = (1, Queue(2, 3))
+Tuple2> dequeued =
+ queue.dequeue();
+----
+
+¿Qué sucede cuando la cola está vacía? En ese caso, `dequeue()` lanzará una excepción `NoSuchElementException`. Para hacerlo de __manera funcional__, esperaríamos más bien un resultado opcional.
+
+[source,java]
+----
+// = Some((1, Queue()))
+Queue.of(1).dequeueOption();
+
+// = None
+Queue.empty().dequeueOption();
+----
+
+Un resultado opcional puede procesarse aún más, ya sea que esté vacío o no.
+
+[source,java]
+----
+// = Queue(1)
+Queue queue = Queue.of(1);
+
+// = Some((1, Queue()))
+Option>> dequeued =
+ queue.dequeueOption();
+
+// = Some(1)
+Option element = dequeued.map(Tuple2::_1);
+
+// = Some(Queue())
+Option> remaining =
+ dequeued.map(Tuple2::_2);
+----
+
+==== Conjuntos Ordenados (__Sorted Set__)
+
+Los conjuntos ordenados son estructuras de datos que se utilizan con más frecuencia que las colas. Utilizamos árboles binarios de búsqueda para modelarlos de manera funcional. Estos árboles están compuestos por nodos que pueden tener hasta dos hijos y valores en cada nodo.
+
+Construimos árboles binarios de búsqueda bajo la presencia de un orden, representado por un `Comparator`. Todos los valores del subárbol izquierdo de cualquier nodo dado son estrictamente menores que el valor del nodo. Todos los valores del subárbol derecho son estrictamente mayores.
+
+[source,java]
+----
+// = TreeSet(1, 2, 3, 4, 6, 7, 8)
+SortedSet xs = TreeSet.of(6, 1, 3, 2, 4, 7, 8);
+----
+
+image::images/binarytree1.png?w=660[Árbol Binario 1]
+
+Las búsquedas en este tipo de árboles se realizan en tiempo O(log n). Comenzamos la búsqueda en la raíz y determinamos si encontramos el elemento. Debido al orden total de los valores, sabemos hacia dónde buscar a continuación, en la rama izquierda o derecha del árbol actual.
+
+[source,java]
+----
+// = TreeSet(1, 2, 3);
+SortedSet set = TreeSet.of(2, 3, 1, 2);
+
+// = TreeSet(3, 2, 1);
+Comparator c = (a, b) -> b - a;
+SortedSet reversed = TreeSet.of(c, 2, 3, 1, 2);
+----
+
+La mayoría de las operaciones sobre árboles son intrínsecamente https://en.wikipedia.org/wiki/Recursion[recursivas]. La función de inserción se comporta de manera similar a la función de búsqueda. Cuando se alcanza el final de un camino de búsqueda, se crea un nuevo nodo y se reconstruye todo el camino hasta la raíz. Siempre que sea posible, los nodos hijos existentes se reutilizan. Por lo tanto, la operación de inserción toma tiempo y espacio O(log n).
+
+[source,java]
+----
+// = TreeSet(1, 2, 3, 4, 5, 6, 7, 8)
+SortedSet ys = xs.add(5);
+----
+
+image::images/binarytree2.png?w=660[Árbol Binario 2]
+
+Para mantener las características de rendimiento de un árbol binario de búsqueda, debe mantenerse equilibrado. Todos los caminos desde la raíz hasta una hoja deben tener aproximadamente la misma longitud.
+
+En Vavr, implementamos un árbol binario de búsqueda basado en un https://en.wikipedia.org/wiki/Red%E2%80%93black_tree[Red/Black Tree] (__Árbol Rojo/Negro__). Este utiliza una estrategia de coloración específica para mantener el equilibrio del árbol durante las operaciones de inserción y eliminación. Para obtener más información sobre este tema, se recomienda leer el libro http://www.amazon.com/Purely-Functional-Structures-Chris-Okasaki/dp/0521663504[Purely Functional Data Structures] de Chris Okasaki.
+
+=== Estado de las Colecciones
+
+En general, estamos observando una convergencia entre los lenguajes de programación. Las características buenas prevalecen, mientras que otras desaparecen. Sin embargo, Java es diferente: está destinado a ser compatible hacia atrás para siempre. Esa es una fortaleza, pero también ralentiza su evolución.
+
+Las expresiones lambda acercaron a Java y Scala, pero aún son muy diferentes. Martin Odersky, el creador de Scala, mencionó recientemente en su charla magistral en la https://www.youtube.com/watch?v=NW5h8d_ZyOs[BDSBTB 2015] el estado de las colecciones en Java 8.
+
+Describió el `Stream` de Java como una forma elegante de un iterador. La API de `Stream` de Java 8 es un ejemplo de una colección __elevada__. Lo que hace es __definir__ una computación y __vincularla__ a una colección específica en otro paso explícito.
+
+[source,java]
+----
+// i + 1
+i.prepareForAddition()
+ .add(1)
+ .mapBackToInteger(Mappers.toInteger())
+----
+
+Así es como funciona la nueva API de `Stream` en Java 8. Es una capa computacional encima de las conocidas colecciones de Java.
+
+[source,java]
+----
+// = ["1", "2", "3"] en Java 8
+Arrays.asList(1, 2, 3)
+ .stream()
+ .map(Object::toString)
+ .collect(Collectors.toList())
+----
+
+Vavr se inspira enormemente en Scala. Así es como debería verse el ejemplo anterior en Java 8.
+
+[source,java]
+----
+// = Stream("1", "2", "3") en Vavr
+Stream.of(1, 2, 3).map(Object::toString)
+----
+
+En el último año, hemos dedicado mucho esfuerzo a implementar la biblioteca de colecciones de Vavr. Comprende los tipos de colecciones más ampliamente utilizados.
+
+==== Seq
+
+Comenzamos nuestro viaje implementando tipos secuenciales. Ya describimos la lista enlazada anteriormente. Luego siguió el __Stream__, una lista enlazada perezosa (__lazy__) que nos permite procesar secuencias de elementos posiblemente infinitas.
+
+image::images/collections-seq.png?w=660[Seq]
+
+Todas las colecciones son `Iterable` y, por lo tanto, pueden usarse en bucles `for` mejorados.
+
+[source,java]
+----
+for (String s : List.of("Java", "Advent")) {
+ // efectos secundarios y mutación
+}
+----
+
+Podemos lograr lo mismo internalizando el bucle e inyectando el comportamiento usando una lambda.
+
+[source,java]
+----
+List.of("Java", "Advent").forEach(s -> {
+ // efectos secundarios y mutación
+});
+----
+
+De todos modos, como vimos anteriormente, preferimos expresiones que devuelvan un valor sobre instrucciones que no devuelven nada. Observando un ejemplo simple, pronto reconoceremos que las instrucciones añaden ruido y separan lo que pertenece junto.
+
+[source,java]
+----
+String join(String... words) {
+ StringBuilder builder = new StringBuilder();
+ for(String s : words) {
+ if (builder.length() > 0) {
+ builder.append(", ");
+ }
+ builder.append(s);
+ }
+ return builder.toString();
+}
+----
+
+Las colecciones de Vavr nos proporcionan muchas funciones para operar sobre los elementos subyacentes. Esto nos permite expresar las cosas de manera muy concisa.
+
+[source,java]
+----
+String join(String... words) {
+ return List.of(words)
+ .intersperse(", ")
+ .foldLeft(new StringBuilder(), StringBuilder::append)
+ .toString();
+}
+----
+
+La mayoría de los objetivos se pueden lograr de diversas maneras usando Vavr. Aquí reducimos todo el cuerpo del método a llamadas de función fluidas en una instancia de List. Incluso podríamos eliminar todo el método y usar directamente nuestra lista para obtener el resultado de la computación.
+
+[source,java]
+----
+List.of(words).mkString(", ");
+----
+
+En una aplicación del mundo real, ahora podemos reducir drásticamente el número de líneas de código y, por lo tanto, disminuir el riesgo de errores.
+
+==== Set y Map
+
+Las secuencias son geniales. Pero, para ser completos, una biblioteca de colecciones también necesita diferentes tipos de `Set` y `Map`.
+
+image::images/collections-set-map.png?w=660[Set y Map]
+
+Describimos cómo modelar conjuntos ordenados con estructuras de árboles binarios. Un `Map` ordenado no es más que un `Set` ordenado que contiene pares clave-valor y que tiene un orden para las claves.
+
+La implementación de `HashMap` se respalda mediante un http://lampwww.epfl.ch/papers/idealhashtrees.pdf[Hash Array Mapped Trie (HAMT)]. En consecuencia, el `HashSet` está respaldado por un HAMT que contiene pares clave-clave.
+
+Nuestro `Map` no tiene un tipo especial de `Entry` para representar pares clave-valor. En su lugar, usamos `Tuple2`, que ya es parte de Vavr. Los campos de un `Tuple` están enumerados.
+
+[source,java]
+----
+// = (1, "A")
+Tuple2 entry = Tuple.of(1, "A");
+
+Integer key = entry._1;
+String value = entry._2;
+----
+
+Los Map y Tuple se utilizan ampliamente en Vavr. Los Tuple son esenciales para manejar tipos de retorno con múltiples valores de forma general.
+
+[source,java]
+----
+// = HashMap((0, List(2, 4)), (1, List(1, 3)))
+List.of(1, 2, 3, 4).groupBy(i -> i % 2);
+
+// = List((a, 0), (b, 1), (c, 2))
+List.of('a', 'b', 'c').zipWithIndex();
+----
+
+En Vavr, exploramos y probamos nuestra biblioteca implementando los https://projecteuler.net/archives[99 problemas de Euler]. Es una excelente prueba de concepto. No dudes en enviar solicitudes de __pull__.
diff --git a/src/docs/asciidoc/es/license.adoc b/src/docs/asciidoc/es/license.adoc
new file mode 100644
index 0000000..84bfe66
--- /dev/null
+++ b/src/docs/asciidoc/es/license.adoc
@@ -0,0 +1,13 @@
+== License
+
+Copyright 2014-2018 Vavr, http://vavr.io
+
+Licenciado bajo la Licencia Apache, Versión 2.0 (la "Licencia");
+no puedes usar este archivo excepto en cumplimiento con la Licencia.
+Puedes obtener una copia de la Licencia en:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+A menos que lo exija la ley aplicable o se acuerde por escrito, el software distribuido bajo la Licencia se distribuye "TAL CUAL",
+SIN GARANTÍAS O CONDICIONES DE NINGÚN TIPO, ya sean expresas o implícitas.
+Consulta la Licencia para conocer los permisos y las limitaciones bajo la Licencia.
diff --git a/src/docs/asciidoc/es/pattern_matching.adoc b/src/docs/asciidoc/es/pattern_matching.adoc
new file mode 100644
index 0000000..03e410c
--- /dev/null
+++ b/src/docs/asciidoc/es/pattern_matching.adoc
@@ -0,0 +1,248 @@
+=== Pattern Matching
+
+SScala tiene coincidencia de patrones (__pattern matching__) nativa, una de las ventajas sobre el Java __**puro**__. The basic syntax is close to Java'sLa sintaxis básica es similar al `switch` de Java:
+
+[source,java]
+----
+val s = i match {
+ case 1 => "one"
+ case 2 => "two"
+ case _ => "?"
+}
+----
+
+Notablemente, __match__ es una expresión, lo que significa que produce un resultado. Además, ofrece:
+
+* Parámetros nombrados: ``case i: Int => "Int " + i``
+* Desestructuración de objetos: ``case Some(i) => i``
+* Condiciones de guarda (guards): ``case Some(i) if i > 0 => "positive " + i``
+* Múltiples condiciones: ``case "-h" | "--help" => displayHelp``
+* Verificaciones en tiempo de compilación para exhaustividad
+
+El __**Pattern matching**__ es una gran característica que nos ahorra escribir cadenas de ramas `if-then-else`. Reduce la cantidad de código mientras se enfoca en las partes relevantes.
+
+==== Fundamentos de Match para Java
+
+Vavr proporciona una API de coincidencia (__match__) que es similar a la de Scala. Se habilita agregando el siguiente import a nuestra aplicación:
+
+[source,java]
+----
+import static io.vavr.API.*;
+----
+
+Teniendo los métodos estáticos __Match__, __Case__ y los __patrones atómicos (__atomic patterns__)__
+
+* ``$()`` - patrón comodín (__wildcard__)
+* ``$(value)`` - patrón de igualdad
+* ``$(predicate)`` - patrón condicional
+
+En el alcance, el ejemplo inicial de Scala puede expresarse de esta manera:
+
+[source,java]
+----
+String s = Match(i).of(
+ Case($(1), "one"),
+ Case($(2), "two"),
+ Case($(), "?")
+);
+----
+
+⚡ Usamos nombres de métodos en mayúsculas uniformes porque 'case' es una palabra clave en Java. Esto hace que la API sea especial.
+
+===== Exhaustividad (__Exhaustiveness__)
+
+El último patrón comodín (__wildcard__) ``$()`` nos protege de un `MatchError`, que se lanza si ningún caso coincide.
+
+Debido a que no podemos realizar verificaciones de exhaustividad como lo hace el compilador de Scala, ofrecemos la posibilidad de devolver un resultado opcional:
+
+[source,java]
+----
+Option s = Match(i).option(
+ Case($(0), "zero")
+);
+----
+
+===== Syntactic Sugar (__Azúcar Sintáctico__)
+
+Como se mostró anteriormente, ``Case`` permite coincidir con patrones condicionales.
+
+[source,java]
+----
+Case($(predicate), ...)
+----
+
+Vavr ofrece un conjunto de predicados predeterminados.
+
+[source,java]
+----
+import static io.vavr.Predicates.*;
+----
+
+Estos pueden usarse para expresar el ejemplo inicial de Scala de la siguiente manera:
+
+[source,java]
+----
+String s = Match(i).of(
+ Case($(is(1)), "one"),
+ Case($(is(2)), "two"),
+ Case($(), "?")
+);
+----
+
+**Condiciones Múltiples**
+
+Usamos el predicado ``isIn`` para verificar múltiples condiciones:
+
+[source,java]
+----
+Case($(isIn("-h", "--help")), ...)
+----
+
+**Realizando Efectos Secundarios**
+
+`Match` actúa como una expresión y produce un valor. Para realizar efectos secundarios (__side-effects__), necesitamos usar la función auxiliar ``run`` que devuelve ``Void``:
+
+[source,java]
+----
+Match(arg).of(
+ Case($(isIn("-h", "--help")), o -> run(this::displayHelp)),
+ Case($(isIn("-v", "--version")), o -> run(this::displayVersion)),
+ Case($(), o -> run(() -> {
+ throw new IllegalArgumentException(arg);
+ }))
+);
+----
+
+⚡ ``run`` se utiliza para evitar ambigüedades y porque ``void`` no es un valor de retorno válido en Java.
+
+*Precaución:* ``run`` no debe usarse como valor de retorno directo, es decir, fuera del cuerpo de una lambda:
+
+[source,java]
+----
+// Incorrecto
+Case($(isIn("-h", "--help")), run(this::displayHelp))
+----
+
+De lo contrario, los `Case` se evaluarán de forma anticipada __antes__ de que los patrones sean comparados, lo que rompe toda la expresión `Match`. En su lugar, se debe usar dentro del cuerpo de una lambda:
+
+[source,java]
+----
+// Correcto
+Case($(isIn("-h", "--help")), o -> run(this::displayHelp))
+----
+
+Como podemos ver, ``run`` es propenso a errores si no se usa correctamente. Ten cuidado. Estamos considerando marcarlo como obsoleto en una versión futura y, tal vez, proporcionar una mejor API para realizar efectos secundarios.
+
+===== Parámetros Nombrados
+
+Vavr aprovecha las lambdas para proporcionar parámetros nombrados para los valores coincidentes.
+
+[source,java]
+----
+Number plusOne = Match(obj).of(
+ Case($(instanceOf(Integer.class)), i -> i + 1),
+ Case($(instanceOf(Double.class)), d -> d + 1),
+ Case($(), o -> { throw new NumberFormatException(); })
+);
+----
+
+Hasta ahora, hemos coincidido valores directamente utilizando patrones atómicos. Si un patrón atómico coincide, el tipo correcto del objeto coincidente se infiere del contexto del patrón.
+
+A continuación, exploraremos patrones recursivos que pueden coincidir con gráficos de objetos de profundidad (teóricamente) arbitraria.
+
+===== Descomposición de Objetos
+
+En Java usamos constructores para instanciar clases. Entendemos la __descomposición de objetos__ como la destrucción de objetos en sus partes.
+
+Mientras que un constructor es una __función__ que se __aplica__ a los argumentos y devuelve una nueva instancia, un deconstructor es una función que toma una instancia y devuelve sus partes. Decimos que un objeto está __descompuesto__.
+
+La destrucción de objetos no necesariamente es una operación única. Por ejemplo, un `LocalDate` puede descomponerse en:
+
+* Los componentes de año, mes y día.
+* El valor `long` que representa los milisegundos desde la época de un `Instant` correspondiente.
+* etc.
+
+==== Patrones
+
+En Vavr usamos patrones para definir cómo se deconstruye una instancia de un tipo específico. Estos patrones pueden usarse junto con la API de coincidencia (`Match`).
+
+===== Patrones Predefinidos
+
+Para muchos tipos de Vavr ya existen patrones de coincidencia predefinidos. Estos se importan mediante
+
+[source,java]
+----
+import static io.vavr.Patterns.*;
+----
+
+Por ejemplo, ahora podemos coincidir con el resultado de un `Try`:
+
+[source,java]
+----
+Match(_try).of(
+ Case($Success($()), value -> ...),
+ Case($Failure($()), x -> ...)
+);
+----
+
+⚡ Un primer prototipo de la API de coincidencia (`Match`) de Vavr permitía extraer una selección definida por el usuario de objetos a partir de un patrón de coincidencia. Sin el soporte adecuado del compilador, esto no es práctico porque el número de métodos generados crecía exponencialmente. La API actual hace un compromiso: todos los patrones se coinciden, pero solo los patrones raíz son __descompuestos__.
+
+[source,java]
+----
+Match(_try).of(
+ Case($Success($Tuple2($("a"), $())), tuple2 -> ...),
+ Case($Failure($(instanceOf(Error.class))), error -> ...)
+);
+----
+
+Aquí los patrones raíz son `Success` y `Failure`. Estos se descomponen en `Tuple2` y `Error`, teniendo los tipos genéricos correctos.
+
+⚡ Los tipos profundamente anidados se infieren según el argumento de `Match` y __**not**__ según los patrones coincidentes.
+
+===== Patrones Definidos por el Usuario
+
+Es esencial poder descomponer objetos arbitrarios, incluidas las instancias de clases finales. Vavr hace esto de forma declarativa al proporcionar las anotaciones en tiempo de compilación ``@Patterns`` y ``@Unapply``.
+
+Para habilitar el procesador de anotaciones, el artefacto http://search.maven.org/#search%7Cga%7C1%7Cvavr-match[vavr-match] debe añadirse como dependencia del proyecto.
+
+⚡ Nota: Por supuesto, los patrones pueden implementarse directamente sin usar el generador de código. Para más información, consulta el código fuente generado.
+
+[source,java]
+----
+import io.vavr.match.annotation.*;
+
+@Patterns
+class My {
+
+ @Unapply
+ static Tuple1 Optional(java.util.Optional optional) {
+ return Tuple.of(optional.orElse(null));
+ }
+}
+----
+
+El procesador de anotaciones coloca un archivo `MyPatterns` en el mismo paquete (por defecto en `target/generated-sources`). También se admiten clases internas. Caso especial: si el nombre de la clase es `$`, el nombre de la clase generada será simplemente `Patterns`, sin prefijo.
+
+===== Guardas (__Guards__)
+
+Ahora podemos coincidir con objetos `Optionals` utilizando __guards__.
+
+[source,java]
+----
+Match(optional).of(
+ Case($Optional($(v -> v != null)), "defined"),
+ Case($Optional($(v -> v == null)), "empty")
+);
+----
+
+Los predicados podrían simplificarse implementando ``isNull`` y ``isNotNull``.
+
+⚡ ¡Y sí, extraer un `null` es extraño! En lugar de usar el `Optional` de Java, prueba con la `Option` de Vavr.
+
+[source,java]
+----
+Match(option).of(
+ Case($Some($()), "defined"),
+ Case($None(), "empty")
+);
+----
diff --git a/src/docs/asciidoc/es/usage_guide.adoc b/src/docs/asciidoc/es/usage_guide.adoc
new file mode 100644
index 0000000..879d574
--- /dev/null
+++ b/src/docs/asciidoc/es/usage_guide.adoc
@@ -0,0 +1,442 @@
+== Guía de Uso
+
+Vavr incluye representaciones bien diseñadas de algunos de los tipos más básicos que, aparentemente, faltan o son rudimentarios en Java: `Tuple`, `Value` y `λ`.
+En Vavr, todo se construye sobre estos tres bloques básicos:
+
+image::images/vavr-overview.png[Vavr Overview]
+
+=== Tuplas
+
+Java carece de una noción general de tuplas. Una tupla combina un número fijo de elementos para que puedan ser tratados como un todo. A diferencia de un array o lista, una tupla puede contener objetos de diferentes tipos, pero también son inmutables.
+Las tuplas tienen tipos como `Tuple1`, `Tuple2`, `Tuple3` y así sucesivamente. Actualmente, hay un límite máximo de 8 elementos. Para acceder a los elementos de una tupla `t`, puedes usar el método `t._1` para acceder al primer elemento, `t._2` para el segundo, y así sucesivamente.
+
+==== Crear una tupla
+
+Aquí tienes un ejemplo de cómo crear una tupla que contiene un `String` y un `Integer`:
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/TupleDemo.java[tags=createTuple]
+----
+<1> Se crea una tupla mediante el método de fábrica estático `Tuple.of()`
+<2> Obtén el primer elemento de esta tupla.
+<3> Obtén el segundo elemento de esta tupla.
+
+==== Mapear una tupla elemento por elemento
+
+El mapeo elemento por elemento evalúa una función por cada elemento de la tupla, devolviendo otra tupla.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/TupleDemo.java[tags=bimapTuple]
+----
+
+==== Mapear una tupla usando un único mapeador
+
+También es posible mapear una tupla usando una sola función de mapeo.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/TupleDemo.java[tags=mapTuple]
+----
+
+==== Transformar una tupla
+
+La transformación crea un nuevo tipo basado en el contenido de la tupla.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/TupleDemo.java[tags=transformTuple]
+----
+
+=== Funciones
+
+La programación funcional se centra en los valores y en la transformación de valores mediante funciones. Java 8 solo proporciona una `Function` que acepta un parámetro y una `BiFunction` que acepta dos parámetros. Vavr proporciona funciones con un límite de hasta 8 parámetros. Las interfaces funcionales se denominan `Function0, Function1, Function2, Function3` y así sucesivamente. Si necesitas una función que lance una excepción comprobada, puedes usar `CheckedFunction1, CheckedFunction2` y así sucesivamente.
+La siguiente expresión lambda crea una función para sumar dos enteros:
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=createFunctionWithLambda]
+----
+
+Esto es una abreviatura para la siguiente definición de clase anónima:
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=createFunctionWithAnonymousClass]
+----
+
+También puedes usar el método de fábrica estático `Function3.of(...)` para crear una función a partir de cualquier referencia de método.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=createFunctionWithFactoryMethod]
+----
+
+
+De hecho, las interfaces funcionales de Vavr son interfaces funcionales de Java 8 potenciadas. También ofrecen características como:
+
+* Composición
+* Elevación (Lifting)
+* Currificación (Currying)
+* Memoización
+
+==== Composición
+Puedes componer funciones. En matemáticas, la composición de funciones es la aplicación de una función al resultado de otra para producir una tercera función. Por ejemplo, las funciones f : X → Y and g : Y → Z pueden componerse para generar una función `h: g(f(x))` que mapea X -> Z.
+Puedes usar `andThen`:
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=composeFunctions1]
+----
+
+o `compose`:
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=composeFunctions2]
+----
+
+==== Elevación (__Lifting__)
+Puedes elevar una función parcial a una función total que devuelve un resultado de tipo `Option`. El término _partial function_ proviene de las matemáticas. Una función parcial de X a Y es una función __f__: X′ → Y, para algún subconjunto X′ de X. Generaliza el concepto de una función __f__: X → Y al no forzar que __f__ asocie cada elemento de X a un elemento de Y. Esto significa que una función parcial funciona correctamente solo para algunos valores de entrada. Si se llama a la función con un valor de entrada no permitido, normalmente lanzará una excepción.
+
+El siguiente método `divide` es una función parcial que solo acepta divisores distintos de cero.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=partialDivideFunction]
+----
+
+Usamos `lift` para convertir `divide` en una función total que está definida para todas las entradas.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=liftedDivideFunction]
+----
+
+<1> Una función elevada devuelve `None` en lugar de lanzar una excepción, si la función se invoca con valores de entrada no permitidos.
+<2> Una función elevada devuelve `Some`, si la función se invoca con valores de entrada permitidos.
+
+El siguiente método `sum` es una función parcial que solo acepta valores de entrada positivos.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=partialFunctionExample]
+----
+<1> La función `sum` lanza una excepción `IllegalArgumentException` para valores de entrada negativos.
+
+Podemos elevar el método `sum` proporcionando la referencia al método.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=liftMethodReference]
+----
+<1> La función elevada captura la excepción `IllegalArgumentException` y la mapea a `None`.
+
+==== Aplicación Parcial
+La aplicación parcial te permite derivar una nueva función a partir de una existente fijando algunos valores. Puedes fijar uno o más parámetros, y el número de parámetros fijados define la aridad de la nueva función, de manera que `new arity = (original arity - fixed parameters)`. Los parámetros se asignan de izquierda a derecha.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=partialApplicationFunction]
+----
+<1> El primer parámetro `a` se fija al valor 2.
+
+Esto puede demostrarse fijando los primeros tres parámetros de una `Function5`, lo que resulta en una `Function2`.
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=partialApplicationFunctionArity5]
+----
+<1> Los parámetros `a`, `b` y `c` se fijan a los valores 2, 3 y 1, respectivamente.
+
+La aplicación parcial difiere de la <>, como se explorará en la sección correspondiente.
+
+==== Currificación (Currying)
+La currificación es una técnica que permite aplicar parcialmente una función fijando un valor para uno de los parámetros, lo que da como resultado una función `Function1` que devuelve otra función `Function1`.
+
+Cuando una `Function2` es _curried_, el resultado es indistinguible de la __aplicación parcial__ de una `Function2` ya que ambas producen una función de aridad 1.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=curryingFunction]
+----
+<1> El primer parámetro `a` se fija al valor 2.
+
+Podrás notar que, aparte del uso de `.curried()`, este código es idéntico al ejemplo de aridad 2 dado en <>. Con funciones de mayor aridad, la diferencia se vuelve evidente.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=curryingFunctionArity3]
+----
+<1> Nota la presencia de funciones adicionales en los parámetros.
+<2> Las llamadas posteriores a `apply` devuelven otra `Function1`, excepto en la llamada final.
+
+==== Memoización
+La memoización es una forma de almacenamiento en caché. Una función memoizada se ejecuta solo una vez y luego devuelve el resultado desde una caché.
+El siguiente ejemplo calcula un número aleatorio en la primera invocación y devuelve el número almacenado en caché en la segunda invocación.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/FunctionsDemo.java[tags=memoizedFunction]
+----
+
+=== Values
+En un entorno funcional, vemos un valor como una especie de https://en.wikipedia.org/wiki/Normal_form_(abstract_rewriting)[forma normal], una expresión que no puede evaluarse más. En Java, expresamos esto haciendo que el estado de un objeto sea `final` y lo llamamos https://en.wikipedia.org/wiki/Immutable_object[objeto immutable].
+El valor funcional de Vavr abstrae sobre objetos inmutables. Las operaciones de escritura eficientes se logran compartiendo memoria inmutable entre instancias. ¡Esto nos proporciona seguridad en hilos automáticamente!
+
+==== Option
+`Option` es un tipo de contenedor monádico que representa un valor opcional. Las instancias de `Option` son ya sea una instancia de `Some` o `None`.
+
+[source,java,indent=0]
+----
+// optional *value*, no more nulls
+Option option = Option.of(...);
+----
+
+Si vienes a Vavr después de usar la clase `Optional` de Java, hay una diferencia crucial. En `Optional`, una llamada a `.map` que resulta en un valor `null` producirá un `Optional` vacío. En Vavr, esto generaría un `Some(null)`, lo que podría llevar a un `NullPointerException`.
+
+Usando `Optional`, este escenario es válido.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/OptionDemo.java[tags=javaOptionalWithMappedNull]
+----
+<1> La opción es `Some("foo")`.
+<2> La opción resultante se vuelve vacía aquí.
+
+Usando la `Option` de Vavr, el mismo escenario resultará en un `NullPointerException`.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/OptionDemo.java[tags=vavrOptionWithMappedNull]
+----
+<1> La opción es `Some("foo")`
+<2> La opción resultante es `Some(null)`
+<3> TLa llamada a `s.toUpperCase()` se invoca sobre un `null`
+
+Esto puede parecer que la implementación de Vavr está rota, pero en realidad no lo está. Más bien, se adhiere al requisito de una mónada (__monad__) de mantener el contexto computacional al llamar a `.map`. En términos de una `Option`, esto significa que llamar a `.map` en un `Some` dará como resultado un `Some` y llamar a `.map` en un `None` dará como resultado un `None`. En el ejemplo de `Optional` de Java mencionado anteriormente, ese contexto cambió de un `Some` a un `None`.
+
+Esto puede parecer que hace que `Option` sea inútil, pero en realidad te obliga a prestar atención a las posibles ocurrencias de `null` y a manejarlas adecuadamente en lugar de aceptarlas sin saberlo. La forma correcta de manejar las ocurrencias de `null` es usar `flatMap`.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/OptionDemo.java[tags=flatMapNullParameter]
+----
+<1> La opción es `Some("foo")`
+<2> La opción resultante es `Some(null)`
+<3> `s`, que es `null`, se convierte en `None`
+
+Alternativamente, mueve el `.flatMap` para que esté ubicado junto al valor que posiblemente sea `null`.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/OptionDemo.java[tags=mapOptionParameter]
+----
+<1> La opción es `Some("foo")`
+<2> La opción resultante es `None`
+
+Esto se explora en más detalle en el http://blog.vavr.io/the-agonizing-death-of-an-astronaut/[blog de Vavr].
+
+==== Try
+`Try` es un tipo de contenedor monádico que representa una computación que puede resultar en una excepción o devolver un valor calculado exitosamente. Es similar a `Either`, pero semánticamente diferente. Una instancia de `Try` puede ser una instancia de `Success` o `Failure`.
+
+[source,java,indent=0]
+----
+// no need to handle exceptions
+Try.of(() -> bunchOfWork()).getOrElse(other);
+----
+
+[source,java,indent=0]
+----
+import static io.vavr.API.*; // $, Case, Match
+import static io.vavr.Predicates.*; // instanceOf
+
+A result = Try.of(this::bunchOfWork)
+ .recover(x -> Match(x).of(
+ Case($(instanceOf(Exception_1.class)), t -> somethingWithException(t)),
+ Case($(instanceOf(Exception_2.class)), t -> somethingWithException(t)),
+ Case($(instanceOf(Exception_n.class)), t -> somethingWithException(t))
+ ))
+ .getOrElse(other);
+----
+
+==== Lazy
+`Lazy` es un tipo de contenedor monádico que representa un valor evaluado de forma perezosa (__lazy__). En comparación con un `Supplier`, `Lazy` realiza __memoización__, es decir, se evalúa solo una vez y, por lo tanto, es referencialmente transparente.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/LazyDemo.java[tags=createLazy]
+----
+
+También puedes crear un valor realmente perezoso (__lazy__) (__esto solo funciona con interfaces__):
+
+[source,java,indent=0]
+----
+CharSequence chars = Lazy.val(() -> "Yay!", CharSequence.class);
+----
+
+==== Either
+`Either` representa un valor de dos tipos posibles. Un `Either` es, o bien un `Left`, o bien un `Right`. Si un `Either` dado es un `Right` y se proyecta a un `Left`, las operaciones de `Left` no tienen efecto sobre el valor de `Right`. Si un `Either` dado es un `Left` y se proyecta a un `Right`, las operaciones de `Right` no tienen efecto sobre el valor de `Left`. Si un `Left` se proyecta a un `Left`, o un `Right` se proyecta a un `Right`, las operaciones sí tienen efecto.
+
+Ejemplo: Una función `compute()`, que da como resultado un valor de tipo `Integer` (en el caso de éxito) o un mensaje de error de tipo `String` (en el caso de fallo). Por convención, el caso de éxito es `Right` y el de fallo es `Left`.
+
+[source,java,indent=0]
+----
+Either value = compute().right().map(i -> i * 2).toEither();
+----
+
+Si el resultado de `compute()` es `Right(1)`, el valor es `Right(2)`.
+Si el resultado de `compute()` es `Left("error")`, el valor es `Left("error")`.
+
+==== Future
+Un `Future` es el resultado de una computación que estará disponible en algún momento. Todas las operaciones proporcionadas son __no bloqueantes__. El `ExecutorService` subyacente se utiliza para ejecutar controladores asíncronos, por ejemplo, mediante `onComplete(...)`.
+
+Un `Future` tiene dos estados: __pendiente__ y __completado__.
+
+*Pendiente:* La computación está en curso. Solo un `Future` pendiente puede completarse o cancelarse.
+
+*Completado:* La computación finalizó exitosamente con un resultado, falló con una excepción o fue cancelada.
+
+Los __callbacks__ pueden registrarse en un `Future` en cualquier momento. Estas acciones se ejecutan tan pronto como el `Future` se completa. Una acción registrada en un `Future` completado se ejecuta inmediatamente. La acción puede ejecutarse en un hilo separado, dependiendo del `ExecutorService` subyacente. Las acciones registradas en un `Future` cancelado se ejecutan con el resultado fallido.
+
+[source,java,indent=0]
+----
+// future *value*, result of an async calculation
+Future future = Future.of(...);
+----
+
+==== Validación (Validation)
+El control de validación (__Validation__) es un __funtor aplicativo__ que facilita la acumulación de errores. Al intentar componer mónadas, el proceso de combinación se detendrá en el primer error encontrado. Sin embargo, `Validation` continuará procesando las funciones de combinación, acumulando todos los errores. Esto es especialmente útil al validar múltiples campos, como un formulario web, cuando deseas conocer todos los errores encontrados en lugar de uno por uno.
+
+Ejemplo: Obtenemos los campos `name` y `age` de un formulario web y queremos crear una instancia válida de `Person`, o devolver la lista de errores de validación.
+
+[source,java,indent=0]
+----
+include::../../../test/java/io/vavr/ValidationDemo.java[tags=validatePerson]
+----
+
+Un valor válido está contenido en una instancia de `Validation.Valid`, mientras que una lista de errores de validación está contenida en una instancia de `Validation.Invalid`.
+
+El siguiente validador se utiliza para combinar diferentes resultados de validación en una sola instancia de `Validation`.
+
+----
+include::../../../test/java/io/vavr/ValidationDemo.java[tags=personValidator]
+----
+
+Si la validación tiene éxito, es decir, si los datos de entrada son válidos, entonces se crea una instancia de `Person` con los campos `name` y `age` proporcionados.
+
+----
+include::../../../test/java/io/vavr/ValidationDemo.java[tags=person]
+----
+
+=== Colecciones
+
+Se ha dedicado mucho esfuerzo a diseñar una biblioteca de colecciones completamente nueva para Java que cumpla con los requisitos de la programación funcional, especialmente la inmutabilidad.
+
+El `Stream` de Java eleva una computación a una capa diferente y se vincula a una colección específica en otro paso explícito. Con Vavr, no necesitamos todo este código adicional repetitivo (__boilerplate__).
+
+Las nuevas colecciones están basadas en http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html[java.lang.Iterable], lo que permite aprovechar un estilo de iteración simplificado.
+
+[source,java]
+----
+// 1000 random numbers
+for (double random : Stream.continually(Math::random).take(1000)) {
+ ...
+}
+----
+
+`TraversableOnce` tiene una gran cantidad de funciones útiles para operar en la colección. Su API es similar a http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html[java.util.stream.Stream], pero es más madura.
+
+==== List
+
+La `List` de Vavr es una lista enlazada inmutable. Las mutaciones crean nuevas instancias. La mayoría de las operaciones se realizan en tiempo lineal. Las operaciones consecutivas se ejecutan una por una.
+
+===== Java 8
+
+[source,java]
+----
+Arrays.asList(1, 2, 3).stream().reduce((i, j) -> i + j);
+----
+
+[source,java]
+----
+IntStream.of(1, 2, 3).sum();
+----
+
+===== Vavr
+
+[source,java]
+----
+// io.vavr.collection.List
+List.of(1, 2, 3).sum();
+----
+
+==== Stream
+
+La implementación de `io.vavr.collection.Stream` es una lista enlazada perezosa (lazy). Los valores se calculan solo cuando se necesitan. Debido a su naturaleza perezosa, la mayoría de las operaciones se realizan en tiempo constante. En general, las operaciones son intermedias y se ejecutan en una sola pasada.
+
+Lo sorprendente de los streams es que podemos usarlos para representar secuencias que son (teóricamente) infinitamente largas.
+
+[source,java]
+----
+// 2, 4, 6, ...
+Stream.from(1).filter(i -> i % 2 == 0);
+----
+
+==== Características de Rendimiento
+
+.Complejidad Temporal de las Operaciones Secuenciales
+[width="100%",frame="topbot",options="header"]
+|====================================================================================================
+| | head() | tail() | get(int) | update(int, T) | prepend(T) | append(T)
+| Array | const | linear | const | const | linear | linear
+| CharSeq | const | linear | const | linear | linear | linear
+| Iterator | const | const | — | — | — | —
+| List | const | const | linear | linear | const | linear
+| Queue | const | const^a^ | linear | linear | const | const
+| PriorityQueue | log | log | — | — | log | log
+| Stream | const | const | linear | linear | const^lazy^ | const^lazy^
+| Vector | const^eff^ | const^eff^ | const ^eff^ | const ^eff^ | const ^eff^ | const ^eff^
+|====================================================================================================
+
+.Complejidad Temporal de las Operaciones en Map/Set
+[width="100%",frame="topbot",options="header"]
+|=================================================================
+| | contains/Key | add/put | remove | min
+| HashMap | const^eff^ | const^eff^ | const^eff^ | linear
+| HashSet | const^eff^ | const^eff^ | const^eff^ | linear
+| LinkedHashMap | const^eff^ | linear | linear | linear
+| LinkedHashSet | const^eff^ | linear | linear | linear
+| Tree | log | log | log | log
+| TreeMap | log | log | log | log
+| TreeSet | log | log | log | log
+|=================================================================
+
+Leyenda:
+
+* const — tiempo constante.
+* const^a^ — tiempo constante amortizado, algunas operaciones pueden tomar más tiempo.
+* const^eff^ — tiempo efectivamente constante, dependiendo de suposiciones como la distribución de claves hash.
+* const^lazy^ — tiempo constante perezoso (__lazy__), la operación se difiere.
+* log — tiempo logarítmico.
+* linear — tiempo lineal.
+
+=== Verificación de Propiedades
+
+La verificación de propiedades (también conocida como http://en.wikipedia.org/wiki/Property_testing[pruebas de propiedades]) es una forma realmente poderosa de probar propiedades de nuestro código de manera funcional. Se basa en la generación de datos aleatorios, que se pasan a una función de verificación definida por el usuario.
+
+Vavr admite pruebas de propiedades en su módulo `io.vavr:vavr-test`, por lo que asegúrate de incluirlo para usarlo en tus pruebas.
+
+[source,java]
+----
+Arbitrary ints = Arbitrary.integer();
+
+// square(int) >= 0: OK, passed 1000 tests.
+Property.def("square(int) >= 0")
+ .forAll(ints)
+ .suchThat(i -> i * i >= 0)
+ .check()
+ .assertIsSatisfied();
+----
+
+Los generadores de estructuras de datos complejas se componen de generadores simples.
diff --git a/src/docs/asciidoc/pl/introduction.adoc b/src/docs/asciidoc/pl/introduction.adoc
deleted file mode 100644
index 25bb1e7..0000000
--- a/src/docs/asciidoc/pl/introduction.adoc
+++ /dev/null
@@ -1,392 +0,0 @@
-== Wprowadzenie
-
-Vavr (formerly called Javaslang) is a functional library for Java 8+ that provides persistent data types and functional control structures.
-
-=== 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://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/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 Vavr and specifically new Java collections.
-
-==== Side-Effects
-
-Java applications are typically plentiful of https://en.wikipedia.org/wiki/Side_effect_(computer_science)[side-effects]. They mutate some sort of state, maybe the outer world. Common side effects are changing objects or variables __in place__, printing to the console, writing to a log file or to a database. Side-effects are considered __harmful__ if they affect the semantics of our program in an undesirable way.
-
-For example, if a function throws an exception and this exception is __interpreted__, it is considered as side-effect that __affects our program__. Furthermore http://c2.com/cgi/wiki?DontUseExceptionsForFlowControl[exceptions are like non-local goto-statements]. They break the normal control-flow. However, real-world applications do perform side-effects.
-
-[source,java]
-----
-int divide(int dividend, int divisor) {
- // throws if divisor is zero
- return dividend / divisor;
-}
-
-----
-
-In a functional setting we are in the favorable situation to encapsulate the side-effect in a Try:
-
-[source,java]
-----
-// = Success(result) or Failure(exception)
-Try divide(Integer dividend, Integer divisor) {
- return Try.of(() -> dividend / divisor);
-}
-
-----
-
-This version of divide does not throw any exception anymore. We made the possible failure explicit by using the type Try.
-
-==== Referential Transparency
-
-A function, or more generally an expression, is called https://en.wikipedia.org/wiki/Referential_transparency[referentially transparent] if a call can be replaced by its value without affecting the behavior of the program. Simply spoken, given the same input the output is always the same.
-
-[source,java]
-----
-// not referentially transparent
-Math.random();
-
-// referentially transparent
-Math.max(1, 2);
-
-----
-
-A function is called https://en.wikipedia.org/wiki/Pure_function[pure] if all expressions involved are referentially transparent. An application composed of pure functions will most probably __just work__ if it compiles. We are able to reason about it. Unit tests are easy to write and debugging becomes a relict of the past.
-
-==== Thinking in Values
-
-Rich Hickey, the creator of Clojure, gave a great talk about https://www.youtube.com/watch?v=-6BsiVyC1kM[The Value of Values]. The most interesting values are https://en.wikipedia.org/wiki/Immutable_object[immutable] values. The main reason is that immutable values
-
-* are inherently thread-safe and hence do not need to be synchronized
-* are stable regarding __equals__ and __hashCode__ and thus are reliable hash keys
-* do not need to be cloned
-* 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__.
-
-Vavr provides the necessary http://static.javadoc.io/io.vavr/vavr/0.10.5/io/vavr/control/package-summary.html[controls] and https://static.javadoc.io/io.vavr/vavr/0.10.4/io/vavr/collection/package-summary.html[collections] to accomplish this goal in every-day Java programming.
-
-=== Data Structures in a Nutshell
-
-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.
-
-==== Mutable Data Structures
-
-Java is an object-oriented programming language. We encapsulate state in objects to achieve data hiding and provide mutator methods to control the state. The https://en.wikipedia.org/wiki/Java_collections_framework[Java collections framework (JCF)] is built upon this idea.
-
-[source,java]
-----
-interface Collection {
- // removes all elements from this collection
- void clear();
-}
-
-----
-
-Today I comprehend a __void__ return type as a smell. It is evidence that https://en.wikipedia.org/wiki/Side_effect_(computer_science)[side-effects] take place, state is mutated. __Shared__ mutable state is an important source of failure, not only in a concurrent setting.
-
-==== Immutable Data Structures
-
-https://en.wikipedia.org/wiki/Immutable_object[Immutable] data structures cannot be modified after their creation. In the context of Java they are widely used in the form of collection wrappers.
-
-[source,java]
-----
-List list = Collections.unmodifiableList(otherList);
-
-// Boom!
-list.add("why not?");
-
-----
-
-There are various libraries that provide us with similar utility methods. The result is always an unmodifiable view of the specific collection. Typically it will throw at runtime when we call a mutator method.
-
-==== Persistent Data Structures
-
-A https://en.wikipedia.org/wiki/Persistent_data_structure[persistent data structure] does preserve the previous version of itself when being modified and is therefore __effectively__ immutable. Fully persistent data structures allow both updates and queries on any version.
-
-Many operations perform only small changes. Just copying the previous version wouldn’t be efficient. To save time and memory, it is crucial to identify similarities between two versions and share as much data as possible.
-
-This model does not impose any implementation details. Here come functional data structures into play.
-
-=== Functional Data Structures
-
-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__.
-
-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://vavr.io/[Vavr] we instantiate a List like this:
-
-[source,java]
-----
-// = List(1, 2, 3)
-List list1 = List.of(1, 2, 3);
-----
-
-Each of the List elements forms a separate List node. The tail of the last element is Nil, the empty List.
-
-image::images/list1.png?w=660[List 1]
-
-This enables us to share elements across different versions of the List.
-
-[source,java]
-----
-// = List(0, 2, 3)
-List list2 = list1.tail().prepend(0);
-----
-
-The new head element 0 is __linked__ to the tail of the original List. The original List remains unmodified.
-
-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 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, 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.
-
-In fact the linked List can also be used to implement a Queue data structure.
-
-==== Queue
-
-A very efficient functional Queue can be implemented based on two linked Lists. The __front__ List holds the elements that are __dequeued__, the __rear__ List holds the elements that are __enqueued__. Both operations enqueue and dequeue perform in O(1).
-
-[source,java]
-----
-Queue queue = Queue.of(1, 2, 3)
- .enqueue(4)
- .enqueue(5);
-----
-
-The initial Queue is created of three elements. Two elements are enqueued on the rear List.
-
-image::images/queue1.png?w=660[Queue 1]
-
-If the front List runs out of elements when dequeueing, the rear List is reversed and becomes the new front List.
-
-image::images/queue2.png?w=660[Queue 2]
-
-When dequeueing an element we get a pair of the first element and the remaining Queue. It is necessary to return the new version of the Queue because functional data structures are immutable and persistent. The original Queue is not affected.
-
-[source,java]
-----
-Queue queue = Queue.of(1, 2, 3);
-
-// = (1, Queue(2, 3))
-Tuple2> dequeued =
- queue.dequeue();
-----
-
-What happens when the Queue is empty? Then dequeue() will throw a NoSuchElementException. To do it the __functional way__ we would rather expect an optional result.
-
-[source,java]
-----
-// = Some((1, Queue()))
-Queue.of(1).dequeueOption();
-
-// = None
-Queue.empty().dequeueOption();
-----
-
-An optional result may be further processed, regardless if it is empty or not.
-
-[source,java]
-----
-// = Queue(1)
-Queue queue = Queue.of(1);
-
-// = Some((1, Queue()))
-Option>> dequeued =
- queue.dequeueOption();
-
-// = Some(1)
-Option element = dequeued.map(Tuple2::_1);
-
-// = Some(Queue())
-Option> remaining =
- dequeued.map(Tuple2::_2);
-----
-
-==== Sorted Set
-
-Sorted Sets are data structures that are more frequently used than Queues. We use binary search trees to model them in a functional way. These trees consist of nodes with up to two children and values at each node.
-
-We build binary search trees in the presence of an ordering, represented by an element Comparator. All values of the left subtree of any given node are strictly less than the value of the given node. All values of the right subtree are strictly greater.
-
-[source,java]
-----
-// = TreeSet(1, 2, 3, 4, 6, 7, 8)
-SortedSet xs = TreeSet.of(6, 1, 3, 2, 4, 7, 8);
-----
-
-image::images/binarytree1.png?w=660[Binary Tree 1]
-
-Searches on such trees run in O(log n) time. We start the search at the root and decide if we found the element. Because of the total ordering of the values we know where to search next, in the left or in the right branch of the current tree.
-
-[source,java]
-----
-// = TreeSet(1, 2, 3);
-SortedSet set = TreeSet.of(2, 3, 1, 2);
-
-// = TreeSet(3, 2, 1);
-Comparator c = (a, b) -> b - a;
-SortedSet reversed = TreeSet.of(c, 2, 3, 1, 2);
-----
-
-Most tree operations are inherently https://en.wikipedia.org/wiki/Recursion[recursive]. The insert function behaves similarly to the search function. When the end of a search path is reached, a new node is created and the whole path is reconstructed up to the root. Existing child nodes are referenced whenever possible. Hence the insert operation takes O(log n) time and space.
-
-[source,java]
-----
-// = TreeSet(1, 2, 3, 4, 5, 6, 7, 8)
-SortedSet ys = xs.add(5);
-----
-
-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 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
-
-Generally we are observing a convergence of programming languages. Good features make it, other disappear. But Java is different, it is bound forever to be backward compatible. That is a strength but also slows down evolution.
-
-Lambda brought Java and Scala closer together, yet they are still so different. Martin Odersky, the creator of Scala, recently mentioned in his https://www.youtube.com/watch?v=NW5h8d_ZyOs[BDSBTB 2015 keynote] the state of the Java 8 collections.
-
-He described Java’s Stream as a fancy form of an Iterator. The Java 8 Stream API is an example of a __lifted__ collection. What it does is to __define__ a computation and __link__ it to a specific collection in another explicit step.
-
-
-[source,java]
-----
-// i + 1
-i.prepareForAddition()
- .add(1)
- .mapBackToInteger(Mappers.toInteger())
-----
-
-This is how the new Java 8 Stream API works. It is a computational layer above the well known Java collections.
-
-[source,java]
-----
-// = ["1", "2", "3"] in Java 8
-Arrays.asList(1, 2, 3)
- .stream()
- .map(Object::toString)
- .collect(Collectors.toList())
-----
-
-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 Vavr
-Stream.of(1, 2, 3).map(Object::toString)
-----
-
-Within the last year we put much effort into implementing the Vavr collection library. It comprises the most widely used collection types.
-
-==== Seq
-
-We started our journey by implementing sequential types. We already described the linked List above. Stream, a lazy linked List, followed. It allows us to process possibly infinite long sequences of elements.
-
-image::images/collections-seq.png?w=660[Seq]
-
-All collections are Iterable and hence could be used in enhanced for-statements.
-
-[source,java]
-----
-for (String s : List.of("Java", "Advent")) {
- // side effects and mutation
-}
-----
-
-We could accomplish the same by internalizing the loop and injecting the behavior using a lambda.
-
-[source,java]
-----
-List.of("Java", "Advent").forEach(s -> {
- // side effects and mutation
-});
-----
-
-Anyway, as we previously saw we prefer expressions that return a value over statements that return nothing. By looking at a simple example, soon we will recognize that statements add noise and divide what belongs together.
-
-[source,java]
-----
-String join(String... words) {
- StringBuilder builder = new StringBuilder();
- for(String s : words) {
- if (builder.length() > 0) {
- builder.append(", ");
- }
- builder.append(s);
- }
- return builder.toString();
-}
-----
-
-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]
-----
-String join(String... words) {
- return List.of(words)
- .intersperse(", ")
- .foldLeft(new StringBuilder(), StringBuilder::append)
- .toString();
-}
-----
-
-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]
-----
-List.of(words).mkString(", ");
-----
-
-In a real world application we are now able to drastically reduce the number of lines of code and hence lower the risk of bugs.
-
-==== Set and Map
-
-Sequences are great. But to be complete, a collection library also needs different types of Sets and Maps.
-
-image::images/collections-set-map.png?w=660[Set and Map]
-
-We described how to model sorted Sets with binary tree structures. A sorted Map is nothing else than a sorted Set containing key-value pairs and having an ordering for the keys.
-
-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 Vavr. The fields of a Tuple are enumerated.
-
-[source,java]
-----
-// = (1, "A")
-Tuple2 entry = Tuple.of(1, "A");
-
-Integer key = entry._1;
-String value = entry._2;
-----
-
-Maps and Tuples are used throughout Vavr. Tuples are inevitable to handle multi-valued return types in a general way.
-
-[source,java]
-----
-// = HashMap((0, List(2, 4)), (1, List(1, 3)))
-List.of(1, 2, 3, 4).groupBy(i -> i % 2);
-
-// = List((a, 0), (b, 1), (c, 2))
-List.of('a', 'b', 'c').zipWithIndex();
-----
-
-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.
diff --git a/src/docs/asciidoc/pl/license.adoc b/src/docs/asciidoc/pl/license.adoc
deleted file mode 100644
index 0c3a4dc..0000000
--- a/src/docs/asciidoc/pl/license.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
-== License
-
-Copyright 2014-2018 Vavr, https://vavr.io
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
diff --git a/src/docs/asciidoc/pl/pattern_matching.adoc b/src/docs/asciidoc/pl/pattern_matching.adoc
deleted file mode 100644
index 242676f..0000000
--- a/src/docs/asciidoc/pl/pattern_matching.adoc
+++ /dev/null
@@ -1,248 +0,0 @@
-=== Pattern Matching
-
-Scala has native pattern matching, one of the advantages over __plain__ Java. The basic syntax is close to Java's switch:
-
-[source,java]
-----
-val s = i match {
- case 1 => "one"
- case 2 => "two"
- case _ => "?"
-}
-----
-
-Notably __match__ is an expression, it yields a result. Furthermore it offers
-
-* named parameters ``case i: Int => "Int " + i``
-* object deconstruction ``case Some(i) => i``
-* guards ``case Some(i) if i > 0 => "positive " + i``
-* multiple conditions ``case "-h" | "--help" => displayHelp``
-* compile-time checks for exhaustiveness
-
-Pattern matching is a great feature that saves us from writing stacks of if-then-else branches. It reduces the amount of code while focusing on the relevant parts.
-
-==== The Basics of Match for Java
-
-Vavr provides a match API that is close to Scala's match. It is enabled by adding the following import to our application:
-
-[source,java]
-----
-import static io.vavr.API.*;
-----
-
-Having the static methods __Match__, __Case__ and the __atomic patterns__
-
-* ``$()`` - wildcard pattern
-* ``$(value)`` - equals pattern
-* ``$(predicate)`` - conditional pattern
-
-in scope, the initial Scala example can be expressed like this:
-
-[source,java]
-----
-String s = Match(i).of(
- Case($(1), "one"),
- Case($(2), "two"),
- Case($(), "?")
-);
-----
-
-⚡ We use uniform upper-case method names because 'case' is a keyword in Java. This makes the API special.
-
-===== Exhaustiveness
-
-The last wildcard pattern ``$()`` saves us from a MatchError which is thrown if no case matches.
-
-Because we can't perform exhaustiveness checks like the Scala compiler, we provide the possibility to return an optional result:
-
-[source,java]
-----
-Option s = Match(i).option(
- Case($(0), "zero")
-);
-----
-
-===== Syntactic Sugar
-
-As already shown, ``Case`` allows to match conditional patterns.
-
-[source,java]
-----
-Case($(predicate), ...)
-----
-
-Vavr offers a set of default predicates.
-
-[source,java]
-----
-import static io.vavr.Predicates.*;
-----
-
-These can be used to express the initial Scala example as follows:
-
-[source,java]
-----
-String s = Match(i).of(
- Case($(is(1)), "one"),
- Case($(is(2)), "two"),
- Case($(), "?")
-);
-----
-
-**Multiple Conditions**
-
-We use the ``isIn`` predicate to check multiple conditions:
-
-[source,java]
-----
-Case($(isIn("-h", "--help")), ...)
-----
-
-**Performing Side-Effects**
-
-Match acts like an expression, it results in a value. In order to perform side-effects we need to use the helper function ``run`` which returns ``Void``:
-
-[source,java]
-----
-Match(arg).of(
- Case($(isIn("-h", "--help")), o -> run(this::displayHelp)),
- Case($(isIn("-v", "--version")), o -> run(this::displayVersion)),
- Case($(), o -> run(() -> {
- throw new IllegalArgumentException(arg);
- }))
-);
-----
-
-⚡ ``run`` is used to get around ambiguities and because ``void`` isn't a valid return value in Java.
-
-*Caution:* ``run`` must not be used as direct return value, i.e. outside of a lambda body:
-
-[source,java]
-----
-// Wrong!
-Case($(isIn("-h", "--help")), run(this::displayHelp))
-----
-
-Otherwise the Cases will be eagerly evaluated __before__ the patterns are matched, which breaks the whole Match expression. Instead we use it within a lambda body:
-
-[source,java]
-----
-// Ok
-Case($(isIn("-h", "--help")), o -> run(this::displayHelp))
-----
-
-As we can see, ``run`` is error prone if not used right. Be careful. We consider deprecating it in a future release and maybe we will also provide a better API for performing side-effects.
-
-===== Named Parameters
-
-Vavr leverages lambdas to provide named parameters for matched values.
-
-[source,java]
-----
-Number plusOne = Match(obj).of(
- Case($(instanceOf(Integer.class)), i -> i + 1),
- Case($(instanceOf(Double.class)), d -> d + 1),
- Case($(), o -> { throw new NumberFormatException(); })
-);
-----
-
-So far we directly matched values using atomic patterns. If an atomic pattern matches, the right type of the matched object is inferred from the context of the pattern.
-
-Next, we will take a look at recursive patterns that are able to match object graphs of (theoretically) arbitrary depth.
-
-===== Object Decomposition
-
-In Java we use constructors to instantiate classes. We understand __object decomposition__ as destruction of objects into their parts.
-
-While a constructor is a __function__ which is __applied__ to arguments and returns a new instance, a deconstructor is a function which takes an instance and returns the parts. We say an object is __unapplied__.
-
-Object destruction is not necessarily a unique operation. For example, a LocalDate can be decomposed to
-
-* the year, month and day components
-* the long value representing the epoch milliseconds of the corresponding Instant
-* etc.
-
-==== Patterns
-
-In Vavr we use patterns to define how an instance of a specific type is deconstructed. These patterns can be used in conjunction with the Match API.
-
-===== Predefined Patterns
-
-For many Vavr types there already exist match patterns. They are imported via
-
-[source,java]
-----
-import static io.vavr.Patterns.*;
-----
-
-For example we are now able to match the result of a Try:
-
-[source,java]
-----
-Match(_try).of(
- Case($Success($()), value -> ...),
- Case($Failure($()), x -> ...)
-);
-----
-
-⚡ A first prototype of Vavr's Match API allowed to extract a user-defined selection of objects from a match pattern. Without proper compiler support this isn't practicable because the number of generated methods exploded exponentially. The current API makes the compromise that all patterns are matched but only the root patterns are __decomposed__.
-
-[source,java]
-----
-Match(_try).of(
- Case($Success($Tuple2($("a"), $())), tuple2 -> ...),
- Case($Failure($(instanceOf(Error.class))), error -> ...)
-);
-----
-
-Here the root patterns are Success and Failure. They are decomposed to Tuple2 and Error, having the correct generic types.
-
-⚡ Deeply nested types are inferred according to the Match argument and __not__ according to the matched patterns.
-
-===== User-Defined Patterns
-
-It is essential to be able to unapply arbitrary objects, including instances of final classes. Vavr does this in a declarative style by providing the compile time annotations ``@Patterns`` and ``@Unapply``.
-
-To enable the annotation processor the artifact http://search.maven.org/#search%7Cga%7C1%7Cvavr-match[vavr-match] needs to be added as project dependency.
-
-⚡ Note: Of course the patterns can be implemented directly without using the code generator. For more information take a look at the generated source.
-
-[source,java]
-----
-import io.vavr.match.annotation.*;
-
-@Patterns
-class My {
-
- @Unapply
- static Tuple1 Optional(java.util.Optional optional) {
- return Tuple.of(optional.orElse(null));
- }
-}
-----
-
-The annotation processor places a file MyPatterns in the same package (by default in target/generated-sources). Inner classes are also supported. Special case: if the class name is $, the generated class name is just Patterns, without prefix.
-
-===== Guards
-
-Now we are able to match Optionals using __guards__.
-
-[source,java]
-----
-Match(optional).of(
- Case($Optional($(v -> v != null)), "defined"),
- Case($Optional($(v -> v == null)), "empty")
-);
-----
-
-The predicates could be simplified by implementing ``isNull`` and ``isNotNull``.
-
-⚡ And yes, extracting null is weird. Instead of using Java's Optional give Vavr's Option a try!
-
-[source,java]
-----
-Match(option).of(
- Case($Some($()), "defined"),
- Case($None(), "empty")
-);
-----
diff --git a/src/docs/asciidoc/pl/usage_guide.adoc b/src/docs/asciidoc/pl/usage_guide.adoc
deleted file mode 100644
index b3f8f93..0000000
--- a/src/docs/asciidoc/pl/usage_guide.adoc
+++ /dev/null
@@ -1,440 +0,0 @@
-== Usage Guide
-
-Vavr comes along with well-designed representations of some of the most basic types which apparently are missing or rudimentary in Java: `Tuple`, `Value` and `λ`.
-In Vavr, everything is built upon these three basic building blocks:
-
-image::images/vavr-overview.png[Vavr Overview]
-
-=== Tuples
-
-Java is missing a general notion of tuples. A Tuple combines a fixed number of elements together so that they can be passed around as a whole. Unlike an array or list, a tuple can hold objects with different types, but they are also immutable.
-Tuples are of type Tuple1, Tuple2, Tuple3 and so on. There currently is an upper limit of 8 elements. To access elements of a tuple `t`, you can use method `t._1` to access the first element, `t._2` to access the second, and so on.
-
-==== Create a tuple
-Here is an example of how to create a tuple holding a String and an Integer:
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/TupleDemo.java[tags=createTuple]
-----
-<1> A tuple is created via the static factory method `Tuple.of()`
-<2> Get the 1st element of this tuple.
-<3> Get the 2nd element of this tuple.
-
-==== Map a tuple component-wise
-
-The component-wise map evaluates a function per element in the tuple, returning another tuple.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/TupleDemo.java[tags=bimapTuple]
-----
-
-==== Map a tuple using one mapper
-
-It is also possible to map a tuple using one mapping function.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/TupleDemo.java[tags=mapTuple]
-----
-
-==== Transform a tuple
-
-Transform creates a new type based on the tuple's contents.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/TupleDemo.java[tags=transformTuple]
-----
-
-=== Functions
-
-Functional programming is all about values and transformation of values using functions. Java 8 just provides a `Function` which accepts one parameter and a `BiFunction` which accepts two parameters. Vavr provides functions up to a limit of 8 parameters. The functional interfaces are of called `Function0, Function1, Function2, Function3` and so on. If you need a function which throws a checked exception you can use `CheckedFunction1, CheckedFunction2` and so on.
-The following lambda expression creates a function to sum two integers:
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=createFunctionWithLambda]
-----
-
-This is a shorthand for the following anonymous class definition:
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=createFunctionWithAnonymousClass]
-----
-
-You can also use the static factory method `Function3.of(...)` to a create a function from any method reference.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=createFunctionWithFactoryMethod]
-----
-
-In fact Vavr functional interfaces are Java 8 functional interfaces on steroids. They also provide features like:
-
-* Composition
-* Lifting
-* Currying
-* Memoization
-
-==== Composition
-You can compose functions. In mathematics, function composition is the application of one function to the result of another to produce a third function. For instance, the functions f : X → Y and g : Y → Z can be composed to yield a function `h: g(f(x))` which maps X -> Z.
-You can use either `andThen`:
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=composeFunctions1]
-----
-
-or `compose`:
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=composeFunctions2]
-----
-
-==== Lifting
-You can lift a partial function into a total function that returns an `Option` result. The term _partial function_ comes from mathematics. A partial function from X to Y is a function f: X′ → Y, for some subset X′ of X. It generalizes the concept of a function f: X → Y by not forcing f to map every element of X to an element of Y. That means a partial function works properly only for some input values. If the function is called with a disallowed input value, it will typically throw an exception.
-
-The following method `divide` is a partial function that only accepts non-zero divisors.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=partialDivideFunction]
-----
-
-We use `lift` to turn `divide` into a total function that is defined for all inputs.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=liftedDivideFunction]
-----
-
-<1> A lifted function returns `None` instead of throwing an exception, if the function is invoked with disallowed input values.
-<2> A lifted function returns `Some`, if the function is invoked with allowed input values.
-
-The following method `sum` is a partial function that only accepts positive input values.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=partialFunctionExample]
-----
-<1> The function `sum` throws an `IllegalArgumentException` for negative input values.
-
-We may lift the `sum` method by providing the methods reference.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=liftMethodReference]
-----
-<1> The lifted function catches the `IllegalArgumentException` and maps it to `None`.
-
-==== Partial application
-Partial application allows you to derive a new function from an existing one by fixing some values. You can fix one or more parameters, and the number of fixed parameters defines the arity of the new function such that `new arity = (original arity - fixed parameters)`. The parameters are bound from left to right.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=partialApplicationFunction]
-----
-<1> The first parameter `a` is fixed to the value 2.
-
-This can be demonstrated by fixing the first three parameters of a `Function5`, resulting in a `Function2`.
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=partialApplicationFunctionArity5]
-----
-<1> The `a`, `b` and `c` parameters are fixed to the values 2, 3 and 1 respectively.
-
-Partial application differs from <>, as will be explored in the relevant section.
-
-==== Currying
-Currying is a technique to partially apply a function by fixing a value for one of the parameters, resulting in a `Function1` function that returns a `Function1`.
-
-When a `Function2` is _curried_, the result is indistinguishable from the _partial application_ of a `Function2` because both result in a 1-arity function.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=curryingFunction]
-----
-<1> The first parameter `a` is fixed to the value 2.
-
-You might notice that, apart from the use of `.curried()`, this code is identical to the 2-arity given example in <>. With higher-arity functions, the difference becomes clear.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=curryingFunctionArity3]
-----
-<1> Note the presence of additional functions in the parameters.
-<2> Further calls to `apply` returns another `Function1`, apart from the final call.
-
-==== Memoization
-Memoization is a form of caching. A memoized function executes only once and then returns the result from a cache.
-The following example calculates a random number on the first invocation and returns the cached number on the second invocation.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/FunctionsDemo.java[tags=memoizedFunction]
-----
-
-=== Values
-In a functional setting we see a value as a kind of https://en.wikipedia.org/wiki/Normal_form_(abstract_rewriting)[normal form], an expression which cannot be further evaluated. In Java we express this by making the state of an object final and call it https://en.wikipedia.org/wiki/Immutable_object[immutable].
-Vavr's functional Value abstracts over immutable objects. Efficient write operations are added by sharing immutable memory between instances. What we get is thread-safety for free!
-
-==== Option
-Option is a monadic container type which represents an optional value. Instances of Option are either an instance of `Some` or the `None`.
-
-[source,java,indent=0]
-----
-// optional *value*, no more nulls
-Option option = Option.of(...);
-----
-
-If you're coming to Vavr after using Java's `Optional` class, there is a crucial difference. In `Optional`, a call to `.map` that results in a null will result in an empty `Optional`. In Vavr, it would result in a `Some(null)` that can then lead to a `NullPointerException`.
-
-Using `Optional`, this scenario is valid.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/OptionDemo.java[tags=javaOptionalWithMappedNull]
-----
-<1> The option is `Some("foo")`
-<2> The resulting option becomes empty here
-
-Using Vavr's `Option`, the same scenario will result in a `NullPointerException`.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/OptionDemo.java[tags=vavrOptionWithMappedNull]
-----
-<1> The option is `Some("foo")`
-<2> The resulting option is `Some(null)`
-<3> The call to `s.toUpperCase()` is invoked on a `null`
-
-This seems like Vavr's implementation is broken, but in fact it's not - rather, it adheres to the requirement of a monad to maintain computational context when calling `.map`. In terms of an `Option`, this means that calling `.map` on a `Some` will result in a `Some`, and calling `.map` on a `None` will result in a `None`. In the Java `Optional` example above, that context changed from a `Some` to a `None`.
-
-This may seem to make `Option` useless, but it actually forces you to pay attention to possible occurrences of `null` and deal with them accordingly instead of unknowingly accepting them. The correct way to deal with occurrences of `null` is to use `flatMap`.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/OptionDemo.java[tags=flatMapNullParameter]
-----
-<1> The option is `Some("foo")`
-<2> The resulting option is `Some(null)`
-<3> `s`, which is `null`, becomes `None`
-
-Alternatively, move the `.flatMap` to be co-located with the the possibly `null` value.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/OptionDemo.java[tags=mapOptionParameter]
-----
-<1> The option is `Some("foo")`
-<2> The resulting option is `None`
-
-This is explored in more detail on the http://blog.vavr.io/the-agonizing-death-of-an-astronaut/[Vavr blog].
-
-==== Try
-Try is a monadic container type which represents a computation that may either result in an exception, or return a successfully computed value. It's similar to, but semantically different from `Either`. Instances of Try, are either an instance of `Success` or `Failure`.
-
-[source,java,indent=0]
-----
-// no need to handle exceptions
-Try.of(() -> bunchOfWork()).getOrElse(other);
-----
-
-[source,java,indent=0]
-----
-import static io.vavr.API.*; // $, Case, Match
-import static io.vavr.Predicates.*; // instanceOf
-
-A result = Try.of(this::bunchOfWork)
- .recover(x -> Match(x).of(
- Case($(instanceOf(Exception_1.class)), t -> somethingWithException(t)),
- Case($(instanceOf(Exception_2.class)), t -> somethingWithException(t)),
- Case($(instanceOf(Exception_n.class)), t -> somethingWithException(t))
- ))
- .getOrElse(other);
-----
-
-==== Lazy
-Lazy is a monadic container type which represents a lazy evaluated value. Compared to a Supplier, Lazy is memoizing, i.e. it evaluates only once and therefore is referentially transparent.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/LazyDemo.java[tags=createLazy]
-----
-
-You may also create a real lazy value (works only with interfaces):
-
-[source,java,indent=0]
-----
-CharSequence chars = Lazy.val(() -> "Yay!", CharSequence.class);
-----
-
-==== Either
-Either represents a value of two possible types. An Either is either a Left or a Right. If the given Either is a Right and projected to a Left, the Left operations have no effect on the Right value. If the given Either is a Left and projected to a Right, the Right operations have no effect on the Left value. If a Left is projected to a Left or a Right is projected to a Right, the operations have an effect.
-
-Example: A compute() function, which results either in an Integer value (in the case of success) or in an error message of type String (in the case of failure). By convention the success case is Right and the failure is Left.
-
-[source,java,indent=0]
-----
-Either value = compute().right().map(i -> i * 2).toEither();
-----
-
-If the result of compute() is Right(1), the value is Right(2).
-If the result of compute() is Left("error"), the value is Left("error").
-
-==== Future
-A Future is a computation result that becomes available at some point. All operations provided are non-blocking. The underlying ExecutorService is used to execute asynchronous handlers, e.g. via onComplete(...).
-
-A Future has two states: pending and completed.
-
-*Pending:* The computation is ongoing. Only a pending future may be completed or cancelled.
-
-*Completed:* The computation finished successfully with a result, failed with an exception or was cancelled.
-
-Callbacks may be registered on a Future at each point of time. These actions are performed as soon as the Future is completed. An action which is registered on a completed Future is immediately performed. The action may run on a separate Thread, depending on the underlying ExecutorService. Actions which are registered on a cancelled Future are performed with the failed result.
-
-[source,java,indent=0]
-----
-// future *value*, result of an async calculation
-Future future = Future.of(...);
-----
-
-==== Validation
-The Validation control is an _applicative functor_ and facilitates accumulating errors. When trying to compose Monads, the combination process will short circuit at the first encountered error. But 'Validation' will continue processing the combining functions, accumulating all errors. This is especially useful when doing validation of multiple fields, say a web form, and you want to know all errors encountered, instead of one at a time.
-
-Example: We get the fields 'name' and 'age' from a web form and want to create either a valid Person instance, or return the list of validation errors.
-
-[source,java,indent=0]
-----
-include::../../../test/java/io/vavr/ValidationDemo.java[tags=validatePerson]
-----
-
-A valid value is contained in a `Validation.Valid` instance, a list of validation errors is contained in a `Validation.Invalid` instance.
-
-The following validator is used to combine different validation results to one `Validation` instance.
-
-----
-include::../../../test/java/io/vavr/ValidationDemo.java[tags=personValidator]
-----
-
-If the validation succeeds, i.e. the input data is valid, then an instance of `Person` is created of the given fields `name` and `age`.
-
-----
-include::../../../test/java/io/vavr/ValidationDemo.java[tags=person]
-----
-
-=== Collections
-
-Much effort has been put into designing an all-new collection library for Java which meets the requirements of functional programming, namely immutability.
-
-Java's Stream lifts a computation to a different layer and links to a specific collection in another explicit step. With Vavr we don't need all this additional boilerplate.
-
-The new collections are based on http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html[java.lang.Iterable], so they leverage the sugared iteration style.
-
-[source,java]
-----
-// 1000 random numbers
-for (double random : Stream.continually(Math::random).take(1000)) {
- ...
-}
-----
-
-`TraversableOnce` has a huge amount of useful functions to operate on the collection. Its API is similar to http://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html[java.util.stream.Stream] but more mature.
-
-==== List
-
-Vavr's `List` is an immutable linked list. Mutations create new instances. Most operations are performed in linear time. Consequent operations are executed one by one.
-
-===== Java 8
-
-[source,java]
-----
-Arrays.asList(1, 2, 3).stream().reduce((i, j) -> i + j);
-----
-
-[source,java]
-----
-IntStream.of(1, 2, 3).sum();
-----
-
-===== Vavr
-
-[source,java]
-----
-// io.vavr.collection.List
-List.of(1, 2, 3).sum();
-----
-
-==== Stream
-
-The `io.vavr.collection.Stream` implementation is a lazy linked list. Values are computed only when needed. Because of its laziness, most operations are performed in constant time. Operations are intermediate in general and executed in a single pass.
-
-The stunning thing about streams is that we can use them to represent sequences that are (theoretically) infinitely long.
-
-[source,java]
-----
-// 2, 4, 6, ...
-Stream.from(1).filter(i -> i % 2 == 0);
-----
-
-==== Performance Characteristics
-
-.Time Complexity of Sequential Operations
-[width="100%",frame="topbot",options="header"]
-|====================================================================================================
-| | head() | tail() | get(int) | update(int, T) | prepend(T) | append(T)
-| Array | const | linear | const | const | linear | linear
-| CharSeq | const | linear | const | linear | linear | linear
-| Iterator | const | const | — | — | — | —
-| List | const | const | linear | linear | const | linear
-| Queue | const | const^a^ | linear | linear | const | const
-| PriorityQueue | log | log | — | — | log | log
-| Stream | const | const | linear | linear | const^lazy^ | const^lazy^
-| Vector | const^eff^ | const^eff^ | const ^eff^ | const ^eff^ | const ^eff^ | const ^eff^
-|====================================================================================================
-
-.Time Complexity of Map/Set Operations
-[width="100%",frame="topbot",options="header"]
-|=================================================================
-| | contains/Key | add/put | remove | min
-| HashMap | const^eff^ | const^eff^ | const^eff^ | linear
-| HashSet | const^eff^ | const^eff^ | const^eff^ | linear
-| LinkedHashMap | const^eff^ | linear | linear | linear
-| LinkedHashSet | const^eff^ | linear | linear | linear
-| Tree | log | log | log | log
-| TreeMap | log | log | log | log
-| TreeSet | log | log | log | log
-|=================================================================
-
-Legend:
-
-* const — constant time
-* const^a^ — amortized constant time, few operations may take longer
-* const^eff^ — effectively constant time, depending on assumptions like distribution of hash keys
-* const^lazy^ — lazy constant time, the operation is deferred
-* log — logarithmic time
-* linear — linear time
-
-=== Property Checking
-
-Property checking (also known as http://en.wikipedia.org/wiki/Property_testing[property testing]) is a truly powerful way to test properties of our code in a functional way. It is based on generated random data, which is passed to a user defined check function.
-
-Vavr has property testing support in its `io.vavr:vavr-test` module, so make sure to include that in order to use it in your tests.
-
-[source,java]
-----
-Arbitrary ints = Arbitrary.integer();
-
-// square(int) >= 0: OK, passed 1000 tests.
-Property.def("square(int) >= 0")
- .forAll(ints)
- .suchThat(i -> i * i >= 0)
- .check()
- .assertIsSatisfied();
-----
-
-Generators of complex data structures are composed of simple generators.