commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ohe...@apache.org
Subject svn commit: r1083195 - /commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java
Date Sat, 19 Mar 2011 15:41:46 GMT
Author: oheger
Date: Sat Mar 19 15:41:46 2011
New Revision: 1083195

URL: http://svn.apache.org/viewvc?rev=1083195&view=rev
Log:
Checkstyle and trailing spaces.

Modified:
    commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java

Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java?rev=1083195&r1=1083194&r2=1083195&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java (original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ImmutablePair.java Sat
Mar 19 15:41:46 2011
@@ -18,12 +18,12 @@ package org.apache.commons.lang3;
 
 /**
  * Immutable concrete manifestation of the {@link Pair} type.
- * 
+ *
  * <p>#ThreadSafe# if the objects are threadsafe</p>
  * @since Lang 3.0
  * @author Matt Benson
  * @version $Id$
- * 
+ *
  * @param <L> left generic type
  * @param <R> right generic type
  */
@@ -38,9 +38,9 @@ public class ImmutablePair<L, R> extends
 
     /**
      * Create a new ImmutablePair instance.
-     * 
-     * @param left
-     * @param right
+     *
+     * @param left the left value
+     * @param right the right value
      */
     public ImmutablePair(L left, R right) {
         super();
@@ -65,20 +65,25 @@ public class ImmutablePair<L, R> extends
     }
 
     /**
-     * {@link java.util.Map.Entry#setValue(Object)} implementation.
-     * @throws UnsupportedOperationException
+     * {@link java.util.Map.Entry#setValue(Object)} implementation. Because this
+     * class is immutable the {@code setValue()} operation is not supported.
+     * Therefore always an exception is thrown.
+     *
+     * @param value the value to set
+     * @throws UnsupportedOperationException as this operation is not supported
      */
-    public R setValue(R arg0) {
+    public R setValue(R value) {
         throw new UnsupportedOperationException();
     }
 
     /**
      * Static fluent creation method for an {@link ImmutablePair}<L, R>:
      * <code>ImmutablePair.of(left, right)</code>
-     * @param <L>
-     * @param <R>
-     * @param left
-     * @param right
+     *
+     * @param <L> the left generic type
+     * @param <R> the right generic type
+     * @param left the let value
+     * @param right the right value
      * @return ImmutablePair<L, R>(left, right)
      */
     public static <L, R> ImmutablePair<L, R> of(L left, R right) {



Mime
View raw message