Class MutableTriple<L,M,R>

java.lang.Object
org.apache.commons.lang3.tuple.Triple<L,M,R>
org.apache.commons.lang3.tuple.MutableTriple<L,M,R>
Type Parameters:
L - The left element type.
M - The middle element type.
R - The right element type.
All Implemented Interfaces:
Serializable, Comparable<Triple<L,M,R>>
public class MutableTriple<L,M,R> extends Triple<L,M,R>
A mutable triple consisting of three Object elements.

Not #ThreadSafe#

Since:
3.2
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final MutableTriple<?,?,?>[]
    EMPTY_ARRAY
    The empty array singleton.
    L
    left
    Left object.
    M
    middle
    Middle object.
    R
    right
    Right object.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MutableTriple()
    Create a new triple instance of three nulls.
    MutableTriple(L left, M middle, R right)
    Create a new triple instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    static <L,M,R> MutableTriple<L,M,R>[]
    emptyArray()
    Returns the empty array singleton that can be assigned without compiler warning.
    L
    getLeft()
    Gets the left element from this triple.
    M
    getMiddle()
    Gets the middle element from this triple.
    R
    getRight()
    Gets the right element from this triple.
    static <L,M,R> MutableTriple<L,M,R>
    of(L left, M middle, R right)
    Obtains a mutable triple of three objects inferring the generic types.
    static <L,M,R> MutableTriple<L,M,R>
    ofNonNull(L left, M middle, R right)
    Obtains a mutable triple of three non-null objects inferring the generic types.
    void
    setLeft(L left)
    Sets the left element of the triple.
    void
    setMiddle(M middle)
    Sets the middle element of the triple.
    void
    setRight(R right)
    Sets the right element of the triple.

    Methods inherited from class Triple

    compareTo, equals, hashCode, toString, toString
    Modifier and Type
    Method
    Description
    int
    compareTo(Triple<L,M,R> other)
    Compares the triple based on the left element, followed by the middle element, finally the right element.
    boolean
    equals(Object obj)
    Compares this triple to another based on the three elements.
    int
    hashCode()
    Returns a suitable hash code.
    String
    toString()
    Returns a String representation of this triple using the format (left,middle,right).
    String
    toString(String format)
    Formats the receiver using the given format.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • EMPTY_ARRAY

      public static final MutableTriple<?,?,?>[] EMPTY_ARRAY
      The empty array singleton.

      Consider using emptyArray() to avoid generics warnings.

      Since:
      3.10

    • left

      public L left
      Left object.

    • middle

      public M middle
      Middle object.

  • Constructor Details

    • MutableTriple

      public MutableTriple()
      Create a new triple instance of three nulls.

    • MutableTriple

      public MutableTriple(L left, M middle, R right)
      Create a new triple instance.
      Parameters:
      left - The left value, may be null.
      middle - The middle value, may be null.
      right - The right value, may be null.

  • Method Details

    • emptyArray

      public static <L,M,R> MutableTriple<L,M,R>[] emptyArray()
      Returns the empty array singleton that can be assigned without compiler warning.
      Type Parameters:
      L - The left element type.
      M - The middle element type.
      R - The right element type.
      Returns:
      The empty array singleton that can be assigned without compiler warning.
      Since:
      3.10

    • of

      public static <L,M,R> MutableTriple<L,M,R> of(L left, M middle, R right)
      Obtains a mutable triple of three objects inferring the generic types.
      Type Parameters:
      L - The left element type.
      M - The middle element type.
      R - The right element type.
      Parameters:
      left - The left element, may be null.
      middle - The middle element, may be null.
      right - The right element, may be null.
      Returns:
      A mutable triple formed from the three parameters, not null.

    • ofNonNull

      public static <L,M,R> MutableTriple<L,M,R> ofNonNull(L left, M middle, R right)
      Obtains a mutable triple of three non-null objects inferring the generic types.
      Type Parameters:
      L - The left element type.
      M - The middle element type.
      R - The right element type.
      Parameters:
      left - The left element, may not be null.
      middle - The middle element, may not be null.
      right - The right element, may not be null.
      Returns:
      A mutable triple formed from the three parameters, not null.
      Throws:
      NullPointerException - Thrown if any input is null.
      Since:
      3.13.0

    • getLeft

      public L getLeft()
      Gets the left element from this triple.
      Specified by:
      getLeft in class Triple<L,M,R>
      Returns:
      The left element, may be null.

    • getMiddle

      public M getMiddle()
      Gets the middle element from this triple.
      Specified by:
      getMiddle in class Triple<L,M,R>
      Returns:
      The middle element, may be null.

    • getRight

      public R getRight()
      Gets the right element from this triple.
      Specified by:
      getRight in class Triple<L,M,R>
      Returns:
      The right element, may be null.

    • setLeft

      public void setLeft(L left)
      Sets the left element of the triple.
      Parameters:
      left - The new value of the left element, may be null.

    • setMiddle

      public void setMiddle(M middle)
      Sets the middle element of the triple.
      Parameters:
      middle - The new value of the middle element, may be null.

    • setRight

      public void setRight(R right)
      Sets the right element of the triple.
      Parameters:
      right - The new value of the right element, may be null.