de.mrapp.util.datastructure.Pair.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-util Show documentation

Contains various utility classes for use in Java development.

The newest version!

/*
 * Copyright 2017 - 2019 Michael Rapp
 *
 * 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 de.mrapp.util.datastructure

import java.io.Serializable

/**
 * A data structure that eases to pass around a pair of two objects. This object provides a
 * sensible implementation of equals(), returning true if equals() is true on each of the contained
 * objects.
 *
 * @param F The type of the first object
 * @param S The type of the second object
 * @property first The first object
 * @property second The second object
 * @author Michael Rapp
 * @since 1.0.0
 */
data class Pair(val first: F?, val second: S?) : Serializable {

    companion object {

        /**
         * Creates a new pair consisting of two objects [first] and [second].
         *
         * @param F The type of the first object
         * @param S The type of the second object
         * @return The pair, which has been created
         */
        fun  create(first: F, second: S): Pair {
            return Pair(first, second)
        }

    }

}