org.conqat.lib.commons.collections.Pair Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of teamscale-lib-commons Show documentation

Provides common utility functions

There is a newer version: 2024.7.2

Show newest version

/*
 * Copyright (c) CQSE GmbH
 *
 * 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 org.conqat.lib.commons.collections;

import org.conqat.lib.commons.test.IndexValueClass;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Simple pair class.
 *
 * @author hummelb
 */
@IndexValueClass
public class Pair extends ImmutablePair {

	/** Version used for serialization. */
	private static final long serialVersionUID = 1;

	/** Constructor. */
	@JsonCreator
	public Pair(@JsonProperty(FIRST_PROPERTY) S first, @JsonProperty(SECOND_PROPERTY) T second) {
		super(first, second);
	}

	/** Copy constructor. */
	public Pair(ImmutablePair p) {
		super(p);
	}

	/** Set the first value. */
	public void setFirst(S first) {
		this.first = first;
	}

	/** Set the second value. */
	public void setSecond(T second) {
		this.second = second;
	}

	/** {@inheritDoc} */
	@Override
	protected Pair clone() {
		return new Pair<>(this);
	}

	/** Factory method for pairs, to simplify creation. */
	public static  Pair createPair(S first, T second) {
		return new Pair<>(first, second);
	}
}