/*
 * 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;

An immutable triple consisting of three Object elements.
Although the implementation is immutable, there is no restriction on the objects that may be stored. If mutable objects are stored in the triple, then the triple itself effectively becomes mutable. The class is also final, so a subclass can not add undesirable behaviour.
#ThreadSafe# if all three objects are thread-safe
Type parameters:
<L> – the left element type
<M> – the middle element type
<R> – the right element type
Since:
3.2/**
 * <p>An immutable triple consisting of three {@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 triple, then the triple
 * itself effectively becomes mutable. The class is also {@code final}, so a subclass
 * can not add undesirable behaviour.</p>
 *
 * <p>#ThreadSafe# if all three objects are thread-safe</p>
 *
 * @param <L> the left element type
 * @param <M> the middle element type
 * @param <R> the right element type
 *
 * @since 3.2
 */
public final class ImmutableTriple<L, M, R> extends Triple<L, M, R> {

    
An immutable triple of nulls.
/**
     * An immutable triple of nulls.
     */
    // This is not defined with generics to avoid warnings in call sites.
    @SuppressWarnings("rawtypes")
    private static final ImmutableTriple NULL = ImmutableTriple.of(null, null, null);

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

    
Returns an immutable triple of nulls.
Type parameters:
<L> – the left element of this triple. Value is null.
<M> – the middle element of this triple. Value is null.
<R> – the right element of this triple. Value is null.
Returns:
an immutable triple of nulls.
Since:
3.6/**
     * Returns an immutable triple of nulls.
     *
     * @param <L> the left element of this triple. Value is {@code null}.
     * @param <M> the middle element of this triple. Value is {@code null}.
     * @param <R> the right element of this triple. Value is {@code null}.
     * @return an immutable triple of nulls.
     * @since 3.6
     */
    @SuppressWarnings("unchecked")
    public static <L, M, R> ImmutableTriple<L, M, R> nullTriple() {
        return NULL;
    }

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

    
Obtains an immutable triple of from three objects inferring the generic types.
This factory allows the triple to be created using inference to
obtain the generic types.
Params:
left –  the left element, may be null
middle –  the middle element, may be null
right –  the right element, may be null
Type parameters:
<L> – the left element type
<M> – the middle element type
<R> – the right element type
Returns:
a triple formed from the three parameters, not null/**
     * <p>Obtains an immutable triple of from three objects inferring the generic types.</p>
     *
     * <p>This factory allows the triple to be created using inference to
     * obtain the generic types.</p>
     *
     * @param <L> the left element type
     * @param <M> the middle element type
     * @param <R> the right element type
     * @param left  the left element, may be null
     * @param middle  the middle element, may be null
     * @param right  the right element, may be null
     * @return a triple formed from the three parameters, not null
     */
    public static <L, M, R> ImmutableTriple<L, M, R> of(final L left, final M middle, final R right) {
        return new ImmutableTriple<>(left, middle, right);
    }

    
Create a new triple instance.
Params:
left –  the left value, may be null
middle – the middle value, may be null
right –  the right value, may be null/**
     * Create a new triple instance.
     *
     * @param left  the left value, may be null
     * @param middle the middle value, may be null
     * @param right  the right value, may be null
     */
    public ImmutableTriple(final L left, final M middle, final R right) {
        super();
        this.left = left;
        this.middle = middle;
        this.right = right;
    }

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

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    @Override
    public M getMiddle() {
        return middle;
    }

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