software.amazon.awssdk.utils.Pair Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bundle

A single bundled dependency that includes all service and dependent JARs with third-party libraries relocated to different namespaces.

There is a newer version: 2.5.20

Show newest version

/*
 * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package software.amazon.awssdk.utils;

import static software.amazon.awssdk.utils.Validate.paramNotNull;

import java.util.function.BiFunction;
import software.amazon.awssdk.annotations.SdkProtectedApi;

/**
 * Simple struct of two values, possibly of different types.
 *
 * @param   Left type
 * @param  Right Type
 */
@SdkProtectedApi
public final class Pair {

    private final LeftT left;
    private final RightT right;

    private Pair(LeftT left, RightT right) {
        this.left = paramNotNull(left, "left");
        this.right = paramNotNull(right, "right");
    }

    /**
     * @return Left value
     */
    public LeftT left() {
        return this.left;
    }

    /**
     * @return Right value
     */
    public RightT right() {
        return this.right;
    }

    /**
     * Apply the function to both the left and right values and return the transformed result.
     *
     * @param function  Function to apply on the {@link Pair}
     * @param  Transformed return type of {@link BiFunction}.
     * @return Result of {@link BiFunction} applied on left and right values of the pair.
     */
    public  ReturnT apply(BiFunction function) {
        return function.apply(left, right);
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof Pair)) {
            return false;
        }

        Pair other = (Pair) obj;
        return other.left.equals(left) && other.right.equals(right);
    }

    @Override
    public int hashCode() {
        return getClass().hashCode() + left.hashCode() + right.hashCode();
    }

    @Override
    public String toString() {
        return "Pair(left=" + left + ", right=" + right + ")";
    }

    public static  Pair of(LeftT left, RightT right) {
        return new Pair<>(left, right);
    }
}