Open Source Repository

Home /commons-lang/commons-lang3-3.0.1 | Repository Home


org/apache/commons/lang3/tuple/ImmutablePair.java
/*
 * 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;

/**
 <p>An immutable pair consisting of two {@code Object} elements.</p>
 
 <p>Although the implementation is immutable, there is no restriction on the objects
 * that may be stored. If mutable objects are stored in the pair, then the pair
 * itself effectively becomes mutable. The class is also not {@code final}, so a subclass
 * could add undesirable behaviour.</p>
 
 <p>#ThreadSafe# if the objects are threadsafe</p>
 *
 @param <L> the left element type
 @param <R> the right element type
 *
 @since Lang 3.0
 @version $Id: ImmutablePair.java 1127544 2011-05-25 14:35:42Z scolebourne $
 */
public final class ImmutablePair<L, R> extends Pair<L, R> {

    /** Serialization version */
    private static final long serialVersionUID = 4954918890077093841L;

    /** Left object */
    public final L left;
    /** Right object */
    public final R right;

    /**
     <p>Obtains an immutable pair of from two objects inferring the generic types.</p>
     
     <p>This factory allows the pair to be created using inference to
     * obtain the generic types.</p>
     
     @param <L> the left element type
     @param <R> 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 <L, R> ImmutablePair<L, R> of(L left, R right) {
        return new ImmutablePair<L, R>(left, right);
    }

    /**
     * Create a new pair instance.
     *
     @param left  the left value, may be null
     @param right  the right value, may be null
     */
    public ImmutablePair(L left, R right) {
        super();
        this.left = left;
        this.right = right;
    }

    //-----------------------------------------------------------------------
    /**
     * {@inheritDoc}
     */
    @Override
    public L getLeft() {
        return left;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public R getRight() {
        return right;
    }

    /**
     <p>Throws {@code UnsupportedOperationException}.</p>
     
     <p>This pair is immutable, so this operation is not supported.</p>
     *
     @param value  the value to set
     @return never
     @throws UnsupportedOperationException as this operation is not supported
     */
    public R setValue(R value) {
        throw new UnsupportedOperationException();
    }

}