com.swirlds.base.utility.Pair Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-base Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2023 Hedera Hashgraph, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 com.swirlds.base.utility;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

/**
 * A simple class to hold a pair of values.
 *
 * @param left value for the left/key side of the pair
 * @param right value for the right/value side of the pair
 * @param  type of the left/key side of the pair
 * @param  type of the right/value side of the pair
 */
public record Pair(L left, R right) {
    /**
     * Create a new pair of values.
     *
     * @param left value for the left/key side of the pair
     * @param right value for the right/value side of the pair
     * @param  type of the left/key side of the pair
     * @param  type of the right/value side of the pair
     *
     * @return a new pair of key and value
     */
    @NonNull
    public static  Pair of(@Nullable final L left, @Nullable final R right) {
        return new Pair<>(left, right);
    }

    /**
     * Convenience method to reference the left site as key
     *
     * @return the left side of the pair
     */
    public L key() {
        return left;
    }

    /**
     * Convenience method to reference the right site as value
     *
     * @return the right side of the pair
     */
    public R value() {
        return right;
    }

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