Merge pull request #15 from SimonHarmonicMinor/issue#14-release-1.1

Issue#14 release 1.1

Author: SimonHarmonicMinor

.travis.yml

@@ -1,10 +1,13 @@
 language: java
 
+git:
+  depth: false
+
 addons:
   sonarcloud:
     organization: simonharmonicminor
     token:
       secure: WeqLn+kxvsbuN6yLGqu1U9r7aZvBkOKv7W/1Pf2dvgrTPcPvLHThrKsAbK8qfWkuoG3Y9FbmzPGH3KfiN+yszIN6OxQl6B85FrlZ/sVGUNrW9idCpohX+WncI4zT32oObZTPcQ2kq1AQQfrI0dmZ5ihqltlV/GbBEhYenXwWmNAPNJXlzR2TaF2ApOzLXjdiX/z6jmU/hZCdxxHkPyxjW0Nm1AzwNWq7s+vsI+plOJDaF9skj+7exKKJ0lxFq/hiyBEazt3HZy87OsxJ/9DhYCKwV4FmQu3cBjkWXXl3334bdF5tELyeHMxJzrpX8XXIKZke2Bu+7uES+vCkVyceavnKBEoPeiBC4CdTyuHordrg11dsrSuS63XLFap0gdbWzVi9gacjdmjoqHnjO69AJ0F4yZvHJGwPlLn5zpq4Qa41aWa5BiU7R8hOzRfqSR4xgeiDemhPJhWYsIfLQ1c4id7kYJUfX/3olq9ffDCXVKXe4UHm5cqaq91u865WdNnn1FQP4coy3D4z3thsmBnRn/Z9bH/IaP4cscOxZsXffSHHjOyLzkkYIOIMW08Bwq5WhrTk4+hHnONcSAkXPt0JYQnG1Tw7nUOQ3borNFqGxw4AUEHisnofBfYpW7ggRyj8xx7JZQI7teLPbhuvaXeFfjL9xvsI+LdOaWclZsN5Qeg=
 
 script:
-  - mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent package org.jacoco:jacoco-maven-plugin:report sonar:sonar -Dsonar.projectKey=SimonHarmonicMinor_Java-Useful-Utils
+  - mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent package org.jacoco:jacoco-maven-plugin:report sonar:sonar -Dsonar.java.binaries=target/classes -Dsonar.projectKey=SimonHarmonicMinor_Java-Useful-Utils

README.md

@@ -15,12 +15,12 @@ Maven:
 <dependency>
     <groupId>com.github.simonharmonicminor</groupId>
     <artifactId>java-useful-utils</artifactId>
-    <version>1.0</version>
+    <version>1.1</version>
 </dependency>
 ```
 Gradle:
 ```groovy
-implementation 'com.github.simonharmonicminor:java-useful-utils:1.0' 
+implementation 'com.github.simonharmonicminor:java-useful-utils:1.1' 
 ```
 
 ### Status
@@ -29,7 +29,7 @@ implementation 'com.github.simonharmonicminor:java-useful-utils:1.0'
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=SimonHarmonicMinor_Java-Useful-Utils&metric=coverage)](https://sonarcloud.io/dashboard?id=SimonHarmonicMinor_Java-Useful-Utils)
 
 ### Usage
-The library contains of three big parts.
+The library consists of three big parts.
 * [Measurement](#measurement)
 * [Monads](#monads) (functional style programming)
 * [Collections](#collections)
@@ -60,7 +60,8 @@ assert exec.getMeasureUnit() == MeasureUnit.MILLIS;
 ```
 
 Simple, right? If you need to measure something in different
-units, just call the appropriate method (`inMillis()` in this case).
+units, just call the appropriate method 
+(`inMillis()`, `inNanos()` or `inSeconds()`).
 
 And what if you need to measure code block from one point to another? 
 Well, `Profiler` is what you need.
@@ -152,6 +153,25 @@ catch (Exception e) {
 }
 ```
 
+If you need the exception that led to the error, you can use
+`orElseGet` variation.
+
+```java
+Try.of(() -> Integer.parseInt(getStringValue))
+   .map(x -> 2 % x)
+   .orElseGet(reason -> {
+       log.error("Something went wrong", reason);
+       return 0;
+   })
+```
+
+`reason` has the type of `Throwable` and it's the instance of that very
+exception that broke the chain. 
+For instance, if `Integer.parseInt` threw an exception, 
+the `reason` would be the type of `NumberFormatException`.
+On the other hand, if `x == 0` in the `map` callback,
+the reason would be the type of `ArithmeticException`. 
+
 ###### Lazy
 
 The name of the monad defines its purpose.
@@ -212,7 +232,7 @@ on every `add` call.
 
 JUU library provides new collections, which interfaces
 do not inherits from java native Collections. 
-Here is the schema ![schema](./juu1.0.png)
+Here is the scheme ![scheme](./juu1.1.png)
 
 The recommended way to instantiate immutable collections is to use `Immutable` class.
 ```java
@@ -266,8 +286,8 @@ ImmutableMap<String, Integer> map =
 
 You can user Stream API with immutable collections as well,
 but `ImmutableList` and `ImmutableSet` provides kotlin-like methods:
-`map`, `flatMap`, `filter`, `sorted`, `min`, `max` and `zip` (for lists).
-`ImmutableList` also has indexed methods: 
+`map`, `flatMap`, `filter`, `min`, `max` and `zip` (for lists).
+`ImmutableList` also has `sorted`, `zipWith`, `zipWithNext` and indexed methods 
 `mapIndexed`, `flatMapIndexed`, `filterIndexed`.
 
 ```java

juu1.0.png

@@ -6,7 +6,7 @@
 
     <groupId>com.github.simonharmonicminor</groupId>
     <artifactId>java-useful-utils</artifactId>
-    <version>1.0</version>
+    <version>1.1</version>
     <packaging>jar</packaging>
 
     <name>Java Useful Utils</name>

juu1.1.png

@@ -24,8 +24,6 @@ public class Immutable {
             new ImmutableHashSet<>(Collections.emptyList());
     private static final ImmutableHashMap<?, ?> EMPTY_HASH_MAP =
             new ImmutableHashMap<>(Collections.emptyMap());
-    private static final ImmutableTreeSet<?> EMPTY_TREE_SET =
-            ImmutableTreeSet.of(Collections.emptyList(), null);
 
     /**
      * Suppresses default constructor, ensuring non-instantiability.
@@ -56,16 +54,6 @@ public static <T> ImmutableSet<T> emptySet() {
         return (ImmutableSet<T>) EMPTY_HASH_SET;
     }
 
-    @SuppressWarnings("unchecked")
-    static <T> ImmutableTreeSet<T> emptyTreeSet() {
-        return (ImmutableTreeSet<T>) EMPTY_TREE_SET;
-    }
-
-    @SuppressWarnings("unchecked")
-    static <T> ImmutableHashSet<T> emptyHashSet() {
-        return (ImmutableHashSet<T>) EMPTY_HASH_SET;
-    }
-
     /**
      * Returns empty map. Does not create the new one, returns the same instance every time
      *
@@ -78,6 +66,13 @@ public static <K, V> ImmutableMap<K, V> emptyMap() {
         return (ImmutableMap<K, V>) EMPTY_HASH_MAP;
     }
 
+
+    private static <T> ImmutableList<T> listOf(Iterable<T> elements, boolean needsCloning) {
+        Objects.requireNonNull(elements);
+        if (!elements.iterator().hasNext()) return emptyList();
+        return new ImmutableArrayList<>(elements, needsCloning);
+    }
+
     /**
      * Creates new immutable list from given elements. If array is empty, returns {@link
      * Immutable#emptyList()}. This is the preferred way of creating immutable lists, unless you need
@@ -90,9 +85,7 @@ public static <K, V> ImmutableMap<K, V> emptyMap() {
      */
     @SafeVarargs
     public static <T> ImmutableList<T> listOf(T... elements) {
-        Objects.requireNonNull(elements);
-        if (elements.length == 0) return emptyList();
-        return new ImmutableArrayList<>(Arrays.stream(elements).collect(Collectors.toList()));
+        return listOf(Arrays.stream(elements).collect(Collectors.toList()), false);
     }
 
     /**
@@ -106,9 +99,17 @@ public static <T> ImmutableList<T> listOf(T... elements) {
      * @throws NullPointerException if {@code elements} is null
      */
     public static <T> ImmutableList<T> listOf(Iterable<T> elements) {
+        return listOf(elements, true);
+    }
+
+    static <T> ImmutableList<T> listOfWithoutCloning(Iterable<T> elements) {
+        return listOf(elements, false);
+    }
+
+    private static <T> ImmutableSet<T> setOf(Iterable<T> elements, boolean needsCloning) {
         Objects.requireNonNull(elements);
-        if (!elements.iterator().hasNext()) return emptyList();
-        return new ImmutableArrayList<>(elements);
+        if (!elements.iterator().hasNext()) return emptySet();
+        return new ImmutableHashSet<>(elements, needsCloning);
     }
 
     /**
@@ -124,8 +125,7 @@ public static <T> ImmutableList<T> listOf(Iterable<T> elements) {
     @SafeVarargs
     public static <T> ImmutableSet<T> setOf(T... elements) {
         Objects.requireNonNull(elements);
-        if (elements.length == 0) return emptySet();
-        return new ImmutableHashSet<>(Arrays.stream(elements).collect(Collectors.toSet()));
+        return setOf(Arrays.stream(elements).collect(Collectors.toSet()), false);
     }
 
     /**
@@ -139,9 +139,11 @@ public static <T> ImmutableSet<T> setOf(T... elements) {
      * @throws NullPointerException if {@code elements} is null
      */
     public static <T> ImmutableSet<T> setOf(Iterable<T> elements) {
-        Objects.requireNonNull(elements);
-        if (!elements.iterator().hasNext()) return emptySet();
-        return new ImmutableHashSet<>(elements);
+        return setOf(elements, true);
+    }
+
+    static <T> ImmutableSet<T> setOfWithoutCloning(Iterable<T> elements) {
+        return setOf(elements, false);
     }
 
     public static <K, V> ImmutableMap<K, V> mapOf(Map<K, V> map) {

pom.xml

@@ -7,6 +7,7 @@
 import java.util.function.*;
 import java.util.stream.Stream;
 
+import static com.github.simonharmonicminor.juu.collection.immutable.Immutable.listOfWithoutCloning;
 import static com.github.simonharmonicminor.juu.collection.immutable.Immutable.setOf;
 import static com.github.simonharmonicminor.juu.collection.immutable.ImmutableCollectionUtils.listEquals;
 import static com.github.simonharmonicminor.juu.collection.immutable.ImmutableCollectionUtils.listToString;
@@ -44,11 +45,6 @@ public ImmutableArrayList(Iterable<T> iterable) {
         }
     }
 
-    private static <R> ImmutableList<R> newImmutableList(List<R> list) {
-        if (list.isEmpty()) return Immutable.emptyList();
-        return new ImmutableArrayList<>(list, false);
-    }
-
     private int normalizeIndex(int index) {
         return index >= 0 ? index : size() + index;
     }
@@ -111,7 +107,7 @@ public ImmutableList<T> slice(int fromIndex, int toIndex, int stepSize) {
             newArrayList.add(get(fromNorm));
             fromNorm = nextValueFunc.apply(fromNorm);
         }
-        return newImmutableList(newArrayList);
+        return listOfWithoutCloning(newArrayList);
     }
 
     @Override
@@ -135,7 +131,7 @@ public ImmutableList<T> concatWith(Iterable<T> iterable) {
         for (T t : iterable) {
             copy.add(t);
         }
-        return newImmutableList(copy);
+        return listOfWithoutCloning(copy);
     }
 
     private static <R> R getValByIndex(ImmutableList<R> immutableList, int index) {
@@ -153,7 +149,7 @@ public <R> ImmutableList<Pair<T, R>> zipWith(ImmutableList<R> list) {
             R right = getValByIndex(list, i);
             newArrayList.add(Pair.of(left, right));
         }
-        return newImmutableList(newArrayList);
+        return listOfWithoutCloning(newArrayList);
     }
 
     @Override
@@ -162,7 +158,7 @@ public ImmutableList<Pair<T, T>> zipWithNext() {
         for (int i = 0; i < size() - 1; i++) {
             newArrayList.add(Pair.of(get(i), get(i + 1)));
         }
-        return newImmutableList(newArrayList);
+        return listOfWithoutCloning(newArrayList);
     }
 
     @Override
@@ -172,7 +168,7 @@ public <R> ImmutableList<R> map(Function<? super T, ? extends R> mapper) {
         for (T t : arrayList) {
             newList.add(mapper.apply(t));
         }
-        return newImmutableList(newList);
+        return listOfWithoutCloning(newList);
     }
 
     @Override
@@ -182,7 +178,7 @@ public <R> ImmutableList<R> mapIndexed(BiFunction<Integer, ? super T, ? extends
         for (int i = 0; i < arrayList.size(); i++) {
             newList.add(mapper.apply(i, arrayList.get(i)));
         }
-        return newImmutableList(newList);
+        return listOfWithoutCloning(newList);
     }
 
     @Override
@@ -193,7 +189,7 @@ public <R> ImmutableList<R> flatMap(Function<? super T, ? extends Iterable<R>> m
             ImmutableArrayList<R> listElement = new ImmutableArrayList<>(mapper.apply(t));
             newList.addAll(listElement.arrayList);
         }
-        return newImmutableList(newList);
+        return listOfWithoutCloning(newList);
     }
 
     @Override
@@ -206,7 +202,7 @@ public <R> ImmutableList<R> flatMapIndexed(
                     new ImmutableArrayList<>(mapper.apply(i, arrayList.get(i)));
             newList.addAll(listElement.arrayList);
         }
-        return newImmutableList(newList);
+        return listOfWithoutCloning(newList);
     }
 
     @Override
@@ -216,7 +212,7 @@ public ImmutableList<T> filter(Predicate<? super T> predicate) {
         for (T t : arrayList) {
             if (predicate.test(t)) newList.add(t);
         }
-        return newImmutableList(newList);
+        return listOfWithoutCloning(newList);
     }
 
     @Override
@@ -226,7 +222,7 @@ public ImmutableList<T> filterIndexed(BiPredicate<Integer, ? super T> predicate)
         for (int i = 0; i < arrayList.size(); i++) {
             if (predicate.test(i, arrayList.get(i))) newList.add(arrayList.get(i));
         }
-        return newImmutableList(newList);
+        return listOfWithoutCloning(newList);
     }
 
     @Override
@@ -242,7 +238,7 @@ public ImmutableList<T> sorted(Comparator<? super T> comparator) {
         Objects.requireNonNull(comparator);
         ArrayList<T> copy = new ArrayList<>(arrayList);
         copy.sort(comparator);
-        return newImmutableList(copy);
+        return listOfWithoutCloning(copy);
     }
 
     @Override
@@ -253,7 +249,7 @@ public ImmutableList<T> limit(int size) {
         for (int i = 0; i < Math.min(size(), size); i++) {
             newList.add(arrayList.get(i));
         }
-        return newImmutableList(newList);
+        return listOfWithoutCloning(newList);
     }
 
     @Override
@@ -264,7 +260,7 @@ public ImmutableList<T> skip(int size) {
         for (int i = Math.min(size, size()); i < arrayList.size(); i++) {
             newList.add(arrayList.get(i));
         }
-        return newImmutableList(newList);
+        return listOfWithoutCloning(newList);
     }
 
     @Override
@@ -305,7 +301,7 @@ public Stream<T> stream() {
 
     @Override
     public Iterator<T> iterator() {
-        return arrayList.iterator();
+        return new UnmodifiableIterator<>(arrayList.iterator());
     }
 
     @Override

src/main/java/com/github/simonharmonicminor/juu/collection/immutable/Immutable.java

@@ -3,8 +3,10 @@
 import com.github.simonharmonicminor.juu.monad.Try;
 
 import java.util.Objects;
+import java.util.Optional;
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
+import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
 class ImmutableCollectionUtils {
@@ -82,4 +84,11 @@ static boolean mapEquals(ImmutableMap<?, ?> current, Object other) {
             return true;
         }).orElse(false);
     }
+
+    static <T> Optional<T> tryGetElement(Supplier<T> supplier) {
+        Objects.requireNonNull(supplier);
+        return Try.of(supplier::get)
+                .map(Optional::ofNullable)
+                .orElse(Optional.empty());
+    }
 }