Package com.unboundid.util

Class ObjectPair<F,S>

java.lang.Object
com.unboundid.util.ObjectPair<F,S>
Type Parameters:
F - The type of the first object.
S - The type of the second object.
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ObjectPair<F,S> extends Object implements Serializable
This class provides a typed pair of objects. It may be used whenever two objects are required but only one is allowed (e.g., returning two values from a method).
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ObjectPair(F first, S second)
    Creates a new object pair with the provided elements.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Indicates whether the provided object is equal to this object pair.
    F
    getFirst()
    Retrieves the first object in this pair.
    S
    getSecond()
    Retrieves the second object in this pair.
    int
    hashCode()
    Retrieves a hash code for this object pair.
    String
    toString()
    Retrieves a string representation of this object pair.
    void
    toString(StringBuilder buffer)
    Appends a string representation of this object pair to the provided buffer.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ObjectPair

      public ObjectPair(@Nullable F first, @Nullable S second)
      Creates a new object pair with the provided elements.
      Parameters:
      first - The first object in this pair.
      second - The second object in this pair.

  • Method Details

    • getFirst

      @Nullable public F getFirst()
      Retrieves the first object in this pair.
      Returns:
      The first object in this pair.

    • getSecond

      @Nullable public S getSecond()
      Retrieves the second object in this pair.
      Returns:
      The second object in this pair.

    • hashCode

      public int hashCode()
      Retrieves a hash code for this object pair.
      Overrides:
      hashCode in class Object
      Returns:
      A hash code for this object pair.

    • equals

      public boolean equals(@Nullable Object o)
      Indicates whether the provided object is equal to this object pair.
      Overrides:
      equals in class Object
      Parameters:
      o - The object for which to make the determination.
      Returns:
      true if the provided object is equal to this object pair, or false if not.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this object pair.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object pair.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this object pair to the provided buffer.
      Parameters:
      buffer - The buffer to which the information should be appended.