Javadoc fixes (#220)

Author: pivovarit

pom.xml

@@ -50,32 +50,6 @@
             <id>sonatype-oss-release</id>
             <build>
                 <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-source-plugin</artifactId>
-                        <version>3.3.1</version>
-                        <executions>
-                            <execution>
-                                <id>attach-sources</id>
-                                <goals>
-                                    <goal>jar-no-fork</goal>
-                                </goals>
-                            </execution>
-                        </executions>
-                    </plugin>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-javadoc-plugin</artifactId>
-                        <version>3.10.0</version>
-                        <executions>
-                            <execution>
-                                <id>attach-javadocs</id>
-                                <goals>
-                                    <goal>jar</goal>
-                                </goals>
-                            </execution>
-                        </executions>
-                    </plugin>
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-gpg-plugin</artifactId>
@@ -178,6 +152,36 @@
                 <extensions>true</extensions>
             </plugin>
 
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>3.3.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.10.0</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <source>8</source>
+                </configuration>
+            </plugin>
+
             <plugin>
                 <groupId>org.moditect</groupId>
                 <artifactId>moditect-maven-plugin</artifactId>

src/main/java/com/pivovarit/function/SneakyThrowUtil.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/pivovarit/function/ThrowingBiConsumer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
  */
 package com.pivovarit.function;
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@
  * Represents an operation that accepts two input arguments and returns no
  * result.  This is the two-arity specialization of {@link ThrowingConsumer}.
  * Unlike most other functional interfaces, {@code ThrowingBiConsumer}  is expected
- * to operate via side-effects.
+ * to operate via side effects.
  *
  * @param <T> the type of the first argument to the operation
  * @param <U> the type of the second argument to the operation
@@ -79,6 +79,9 @@ static <T, U> BiConsumer<T, U> unchecked(ThrowingBiConsumer<T, U, ?> consumer) {
 
     /**
      * Returns a new BiConsumer instance which rethrows the checked exception using the Sneaky Throws pattern
+     * @param consumer ThrowingBiConsumer operation throwing checked exception
+     * @param <T> the type of the first argument to the operation
+     * @param <U> the type of the second argument to the operation
      * @return BiConsumer instance that rethrows the checked exception using the Sneaky Throws pattern
      */
     static <T, U> BiConsumer<T, U> sneaky(ThrowingBiConsumer<T, U, ?> consumer) {

src/main/java/com/pivovarit/function/ThrowingBiFunction.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/pivovarit/function/ThrowingBiPredicate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,7 +42,12 @@ static <T, U> BiPredicate<T, U> unchecked(ThrowingBiPredicate<T, U, ?> predicate
     }
 
     /**
+     * Returns a new BiPredicate instance which rethrows the checked exception using the Sneaky Throws pattern
+     *
      * @return BiPredicate instance that rethrows the checked exception using the Sneaky Throws pattern
+     * @param predicate operation throwing checked exception
+     * @param <T> type of the first argument to the predicate
+     * @param <U> type of the second argument to the predicate
      */
     static <T, U> BiPredicate<T, U> sneaky(ThrowingBiPredicate<T, U, ?> predicate) {
         Objects.requireNonNull(predicate);

src/main/java/com/pivovarit/function/ThrowingBinaryOperator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/pivovarit/function/ThrowingConsumer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,6 +42,8 @@ static <T> Consumer<T> unchecked(ThrowingConsumer<T, ?> consumer) {
 
     /**
      * Returns a new BiConsumer instance which rethrows the checked exception using the Sneaky Throws pattern
+     * @param consumer operation throwing checked exception
+     * @param <T> type of the argument to the consumer
      * @return BiConsumer instance that rethrows the checked exception using the Sneaky Throws pattern
      */
     static <T> Consumer<T> sneaky(ThrowingConsumer<T, ?> consumer) {

src/main/java/com/pivovarit/function/ThrowingFunction.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,17 +36,36 @@ public interface ThrowingFunction<T, R, E extends Exception> {
     R apply(T arg) throws E;
 
     /**
+     * Returns a new Function instance which wraps a result of the given function in an Optional, returning an empty Optional in case of a checked exception
+     *
+     * @param f operation throwing checked exception
+     * @param <T> type of the argument to the function
+     * @param <R> type of the result of the function
      * @return a Function that returns the result of the given function as an Optional instance.
-     * In case of a failure, empty Optional is returned
      */
     static <T, R> Function<T, Optional<R>> lifted(final ThrowingFunction<T, R, ?> f) {
         return requireNonNull(f).lift();
     }
 
+    /**
+     * Returns a new Function instance which rethrows the checked exception using the Sneaky Throws pattern
+     *
+     * @param f operation throwing checked exception
+     * @param <T> type of the argument to the function
+     * @param <R> type of the result of the function
+     * @return Function instance that rethrows the checked exception using the Sneaky Throws pattern
+     */
     static <T, R> Function<T, R> unchecked(final ThrowingFunction<T, R, ?> f) {
         return requireNonNull(f).uncheck();
     }
 
+    /**
+     * Returns a new Function instance which rethrows the checked exception using the Sneaky Throws pattern
+     * @param function operation throwing checked exception
+     * @param <T1> type of the argument to the function
+     * @param <R> type of the result of the function
+     * @return Function instance that rethrows the checked exception using the Sneaky Throws pattern
+     */
     static <T1, R> Function<T1, R> sneaky(ThrowingFunction<? super T1, ? extends R, ?> function) {
         requireNonNull(function);
         return t -> {

src/main/java/com/pivovarit/function/ThrowingIntFunction.java

@@ -9,14 +9,12 @@
 import static java.util.Objects.requireNonNull;
 
 /**
- * Functional interface mirroring {@link IntFunction<R>} for primitive ints from the java.util.function package.
- * This allows wrapping a exceptions in a runtime exception: {@link WrappedException}
- * <p>
- * As this adheres to the {@link IntFunction} interface, compose and andThen (as you might be familiar with from
- * {@link java.util.function.Function} are not available.
+ * Represents a function that accepts an int-valued argument and returns a value;
+ * Function might throw a checked exception instance.
  *
  * @param <R> the type of the result of the function
  * @param <E> the type of the thrown checked exception
+ * @author Grzegorz Piwowarek
  */
 @FunctionalInterface
 public interface ThrowingIntFunction<R, E extends Exception> {
@@ -38,13 +36,21 @@ static <R> IntFunction<R> unchecked(final ThrowingIntFunction<R, ?> f) {
     }
 
     /**
+     * Returns a new Function instance which wraps a result of the given function in an Optional, returning an empty Optional in case of a checked exception
+     * @param f operation throwing checked exception
+     * @param <R> type of the result of the function
      * @return a Function that returns the result of the given function as an Optional instance.
-     * In case of a failure, empty Optional is returned
      */
     static <R> IntFunction<Optional<R>> lifted(final ThrowingIntFunction<R, ?> f) {
         return requireNonNull(f).lift();
     }
 
+    /**
+     * Returns a new Function instance which rethrows the checked exception using the Sneaky Throws pattern
+     * @param function operation throwing checked exception
+     * @param <R> type of the result of the function
+     * @return Function instance that rethrows the checked exception using the Sneaky Throws pattern
+     */
     static <R> IntFunction<R> sneaky(ThrowingIntFunction<? extends R, ?> function) {
         requireNonNull(function);
         return t -> {

src/main/java/com/pivovarit/function/ThrowingPredicate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.