Class KeyValue<A,​B>

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Tuple>, java.lang.Iterable<java.lang.Object>, IValueKey<A>, IValueValue<B>

    public final class KeyValue<A,​B>
    extends Tuple
    implements IValueKey<A>, IValueValue<B>

    A tuple of two elements, with positions 0 and 1 renamed as "key" and "value", respectively.

    Since:
    1.0
    See Also:
    Serialized Form
    • Constructor Detail

      • KeyValue

        public KeyValue​(A key,
                        B value)
    • Method Detail

      • with

        public static <A,​B> KeyValue<A,​B> with​(A key,
                                                           B value)
      • fromArray

        public static <X> KeyValue<X,​X> fromArray​(X[] array)

        Create tuple from array. Array has to have exactly two elements.

        Type Parameters:
        X - the array component type
        Parameters:
        array - the array to be converted to a tuple
        Returns:
        the tuple
      • fromCollection

        public static <X> KeyValue<X,​X> fromCollection​(java.util.Collection<X> collection)
      • fromIterable

        public static <X> KeyValue<X,​X> fromIterable​(java.lang.Iterable<X> iterable)
      • fromIterable

        public static <X> KeyValue<X,​X> fromIterable​(java.lang.Iterable<X> iterable,
                                                           int index)
      • fromIterable

        private static <X> KeyValue<X,​X> fromIterable​(java.lang.Iterable<X> iterable,
                                                            int index,
                                                            boolean exactSize)
      • getSize

        public int getSize()
        Description copied from class: Tuple

        Return the size of the tuple.

        Specified by:
        getSize in class Tuple
        Returns:
        the size of the tuple.
      • setKey

        public <X> KeyValue<X,​B> setKey​(X key)
      • setValue

        public <Y> KeyValue<A,​Y> setValue​(Y value)