net.sf.javagimmicks.util8.Pair Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gimmicks Show documentation

Utility classes, APIs and tools for Java

There is a newer version: 0.99-alpha1

package net.sf.javagimmicks.util8;

import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.Consumer;

/**
 * Represents a pair of two typed values.
 * 
 * @param 
 *           the type of the first element
 * @param 
 *           the type of the second element
 */
public interface Pair
{
   /**
    * Creates a new instance.
    * 
    * @param a
    *           the first element
    * @param b
    *           the second element
    * @param 
    *           the type of the first element
    * @param 
    *           the type of the second element
    * @return the new {@link Pair} instance
    */
   static  Pair of(final A a, final B b)
   {
      return new PairImpl(a, b);
   }

   /**
    * Returns the first element.
    * 
    * @return the first element
    */
   A getA();

   /**
    * Returns the second element.
    * 
    * @return the second element
    */
   B getB();

   /**
    * Feeds a given {@link BiConsumer} with the two contained values.
    * 
    * @param consumer
    *           the {@link BiConsumer} to feed with the contained values
    */
   public default void feed(final BiConsumer consumer)
   {
      consumer.accept(getA(), getB());
   }

   /**
    * Feeds two given {@link Consumer}s with the two contained values.
    * 
    * @param consumerA
    *           the {@link Consumer} for the first value
    * @param consumerB
    *           the {@link Consumer} for the second value
    */
   public default void feed(final Consumer consumerA, final Consumer consumerB)
   {
      consumerA.accept(getA());
      consumerB.accept(getB());
   }

   /**
    * Applies the two contained values to a given {@link BiFunction}.
    * 
    * @param function
    *           the {@link BiFunction} where to apply the contained values
    * @param 
    *           the return type of the {@link BiFunction}
    * @return the result of applying the {@link BiFunction}
    */
   public default  T apply(final BiFunction function)
   {
      return function.apply(getA(), getB());
   }
}