alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Java example source code file (ImmutablePair.java)

This example Java source code file (ImmutablePair.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

immutablepair, override, unsupportedoperationexception

The ImmutablePair.java Java example source code

/*
 * 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>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 {@code final}, so a subclass * can not add undesirable behaviour.</p> * * <p>#ThreadSafe# if both paired objects are thread-safe

* * @param <L> the left element type * @param <R> the right element type * * @since Lang 3.0 */ public final class ImmutablePair<L, R> extends Pair { /** 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>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 of(final L left, final 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(final L left, final 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>This pair is immutable, so this operation is not supported.

* * @param value the value to set * @return never * @throws UnsupportedOperationException as this operation is not supported */ @Override public R setValue(final R value) { throw new UnsupportedOperationException(); } }

Other Java examples (source code examples)

Here is a short list of links related to this Java ImmutablePair.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.