net.mintern.primitive.pair.ImmutableObjDoublePair Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of primitive-pairs Show documentation
Pairs for double, int, and long values
The newest version!
/*
 * Derived from code that was licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with Apache Commons Lang 3 for
 * additional information regarding copyright ownership.
 *
 * Brandon Mintern and the ASF license 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 net.mintern.primitive.pair;

import org.apache.commons.lang3.tuple.ImmutablePair;

/**
 * An immutable pair consisting of an {@code Object} and a {@code double} element, providing a
 * version of {@link ImmutablePair} that avoids unnecessary {@code Double} boxing.
 * 
 * Although the implementation is immutable, there is no restriction on the objects that may be
 * stored. If a mutable object is stored in the pair, then the pair itself effectively becomes
 * mutable. The class is also {@code final}, so a subclass cannot add undesirable behavior.
 * 
 * #ThreadSafe# if the left object is thread-safe
 *
 * @param  the left element type
 * @author Brandon Mintern
 */
public final class ImmutableObjDoublePair extends ObjDoublePair {

    private static final long serialVersionUID = 1;

    /**
     * Obtains an immutable pair of the given {@code Object} and {@code double} values.
     *
     * @param  the left element type
     * @param left  the left element, may be null
     * @param right  the right element
     * @return a pair formed from the two parameters, not null
     */
    public static  ImmutableObjDoublePair of(L left, double right) {
        return new ImmutableObjDoublePair<>(left, right);
    }

    public final L left;
    public final double right;

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

    @Override
    public L getLeft() {
        return left;
    }

    @Override
    public double getRight() {
        return right;
    }

    @Override
    public ImmutablePair boxed() {
        return new ImmutablePair<>(left, right);
    }
}