All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.groupbyinc.common.apache.commons.lang3.tuple.MutablePair Maven / Gradle / Ivy

The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.commons.lang3.tuple;

/**
 * 

A mutable pair consisting of two {@code Object} elements.

* *

Not #ThreadSafe#

* * @param the left element type * @param the right element type * * @since 3.0 */ public class MutablePair extends Pair { /** Serialization version */ private static final long serialVersionUID = 4954918890077093841L; /** Left object */ public L left; /** Right object */ public R right; /** *

Obtains a mutable pair of two objects inferring the generic types.

* *

This factory allows the pair to be created using inference to * obtain the generic types.

* * @param the left element type * @param the right element type * @param left the left element, may be null * @param right the right element, may be null * @return a pair formed from the two parameters, not null */ public static MutablePair of(final L left, final R right) { return new MutablePair<>(left, right); } /** * Create a new pair instance of two nulls. */ public MutablePair() { super(); } /** * Create a new pair instance. * * @param left the left value, may be null * @param right the right value, may be null */ public MutablePair(final L left, final R right) { super(); this.left = left; this.right = right; } //----------------------------------------------------------------------- /** * {@inheritDoc} */ @Override public L getLeft() { return left; } /** * Sets the left element of the pair. * * @param left the new value of the left element, may be null */ public void setLeft(final L left) { this.left = left; } /** * {@inheritDoc} */ @Override public R getRight() { return right; } /** * Sets the right element of the pair. * * @param right the new value of the right element, may be null */ public void setRight(final R right) { this.right = right; } /** * Sets the {@code Map.Entry} value. * This sets the right element of the pair. * * @param value the right value to set, not null * @return the old value for the right element */ @Override public R setValue(final R value) { final R result = getRight(); setRight(value); return result; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy