diff options
| author | Bananeweizen <Bananeweizen@gmx.de> | 2011-09-03 11:44:37 -0700 |
|---|---|---|
| committer | Bananeweizen <Bananeweizen@gmx.de> | 2011-09-03 11:44:37 -0700 |
| commit | 5878215750b36147e31d4e44d39f5cee5a686a24 (patch) | |
| tree | 05ed634bef7aa97c6aef53dca0bae8947b790669 /src/org/apache/commons/lang3/tuple/ImmutablePair.java | |
| parent | 1ca5b0ddbe8ecaa67b1606f386ae398c0bf8da10 (diff) | |
| parent | 5d6cd5f76c3682f70e4fa18182849fb2110a6aca (diff) | |
| download | cgeo-5878215750b36147e31d4e44d39f5cee5a686a24.zip cgeo-5878215750b36147e31d4e44d39f5cee5a686a24.tar.gz cgeo-5878215750b36147e31d4e44d39f5cee5a686a24.tar.bz2 | |
Merge pull request #359 from gezb/301
Fix for issue #301 - include Apache commons lang library
Diffstat (limited to 'src/org/apache/commons/lang3/tuple/ImmutablePair.java')
| -rw-r--r-- | src/org/apache/commons/lang3/tuple/ImmutablePair.java | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/src/org/apache/commons/lang3/tuple/ImmutablePair.java b/src/org/apache/commons/lang3/tuple/ImmutablePair.java new file mode 100644 index 0000000..8e88a43 --- /dev/null +++ b/src/org/apache/commons/lang3/tuple/ImmutablePair.java @@ -0,0 +1,103 @@ +/*
+ * 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();
+ }
+
+}
|