You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by da...@apache.org on 2015/10/24 18:05:28 UTC

wicket git commit: Zero warnings in wicket-request

Repository: wicket
Updated Branches:
  refs/heads/wicket-7.x 8e6ac7779 -> 741a21965


Zero warnings in wicket-request


Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/741a2196
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/741a2196
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/741a2196

Branch: refs/heads/wicket-7.x
Commit: 741a21965d97a86a111bc7a0dba2776037c304d5
Parents: 8e6ac77
Author: Martijn Dashorst <da...@apache.org>
Authored: Sat Oct 24 18:05:19 2015 +0200
Committer: Martijn Dashorst <da...@apache.org>
Committed: Sat Oct 24 18:05:19 2015 +0200

----------------------------------------------------------------------
 wicket-request/pom.xml                          |   1 -
 .../wicket/request/HttpHeaderCollection.java    |  17 ++-
 .../mapper/parameter/INamedParameters.java      |  13 +-
 .../mapper/parameter/PageParameters.java        |  22 ++++
 .../request/HttpHeaderCollectionTest.java       |   1 +
 .../java/org/apache/wicket/request/UrlTest.java | 127 +------------------
 6 files changed, 53 insertions(+), 128 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/wicket/blob/741a2196/wicket-request/pom.xml
----------------------------------------------------------------------
diff --git a/wicket-request/pom.xml b/wicket-request/pom.xml
index bb187c9..128ce13 100755
--- a/wicket-request/pom.xml
+++ b/wicket-request/pom.xml
@@ -22,7 +22,6 @@
     <groupId>org.apache.wicket</groupId>
     <version>7.2.0-SNAPSHOT</version>
   </parent>
-  <groupId>org.apache.wicket</groupId>
   <artifactId>wicket-request</artifactId>
   <name>Wicket Request</name>
   <url>http://maven.apache.org</url>

http://git-wip-us.apache.org/repos/asf/wicket/blob/741a2196/wicket-request/src/main/java/org/apache/wicket/request/HttpHeaderCollection.java
----------------------------------------------------------------------
diff --git a/wicket-request/src/main/java/org/apache/wicket/request/HttpHeaderCollection.java b/wicket-request/src/main/java/org/apache/wicket/request/HttpHeaderCollection.java
index e3a922c..126e8d1 100644
--- a/wicket-request/src/main/java/org/apache/wicket/request/HttpHeaderCollection.java
+++ b/wicket-request/src/main/java/org/apache/wicket/request/HttpHeaderCollection.java
@@ -30,7 +30,7 @@ import org.apache.wicket.util.lang.Args;
 import org.apache.wicket.util.time.Time;
 
 /**
- * a multivalue map of headers names and header values suitable for processing http request and
+ * A multivalue map of headers names and header values suitable for processing http request and
  * response headers.
  * 
  * @author Peter Ertl
@@ -44,6 +44,9 @@ public class HttpHeaderCollection
 	/** returned in case no header values were found */
 	private static final String[] NO_VALUES = new String[0];
 
+	/**
+	 * Constructor.
+	 */
 	public HttpHeaderCollection()
 	{
 		headers = new HashMap<>();
@@ -237,6 +240,11 @@ public class HttpHeaderCollection
 		return values;
 	}
 
+	/**
+	 * Gets the header identified with the name as a String.
+	 * @param name
+	 * @return {@code null} when the header was not found
+	 */
 	public String getHeader(String name)
 	{
 		final List<Object> objects = headers.get(new HeaderKey(name));
@@ -248,6 +256,11 @@ public class HttpHeaderCollection
 		return valueToString(objects.get(0));
 	}
 
+	/**
+	 * Gets the header identified with the name as a Time
+	 * @param name
+	 * @return {@code null} when the header was not found
+	 */
 	public Time getDateHeader(String name)
 	{
 		final List<Object> objects = headers.get(new HeaderKey(name));
@@ -266,7 +279,7 @@ public class HttpHeaderCollection
 	}
 
 	/**
-	 * check if collection is empty
+	 * Check if collection is empty
 	 * 
 	 * @return <code>true</code> if collection is empty, <code>false</code> otherwise
 	 */

http://git-wip-us.apache.org/repos/asf/wicket/blob/741a2196/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/INamedParameters.java
----------------------------------------------------------------------
diff --git a/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/INamedParameters.java b/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/INamedParameters.java
index 45b4c6c..447c9cc 100644
--- a/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/INamedParameters.java
+++ b/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/INamedParameters.java
@@ -58,6 +58,7 @@ public interface INamedParameters
 	 * 
 	 * @author Matej Knopp
 	 */
+	@SuppressWarnings("serial")
 	public static class NamedPair implements IClusterable
 	{
 		private final String key;
@@ -65,7 +66,7 @@ public interface INamedParameters
 		private final Type type;
 
 		/**
-		 * Constructor
+		 * Creates a named parameter entry that is set manually in the application code.
 		 * 
 		 * @param key
 		 * @param value
@@ -75,6 +76,13 @@ public interface INamedParameters
 			this(key, value, Type.MANUAL);
 		}
 
+		/**
+		 * Creates a named parameter entry
+		 * 
+		 * @param key
+		 * @param value
+		 * @param type
+		 */
 		public NamedPair(final String key, final String value, Type type)
 		{
 			this.key = Args.notEmpty(key, "key");
@@ -98,6 +106,9 @@ public interface INamedParameters
 			return value;
 		}
 
+		/**
+		 * @return type
+		 */
 		public Type getType()
 		{
 			return type;

http://git-wip-us.apache.org/repos/asf/wicket/blob/741a2196/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/PageParameters.java
----------------------------------------------------------------------
diff --git a/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/PageParameters.java b/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/PageParameters.java
index df74439..f283a80 100644
--- a/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/PageParameters.java
+++ b/wicket-request/src/main/java/org/apache/wicket/request/mapper/parameter/PageParameters.java
@@ -273,6 +273,13 @@ public class PageParameters implements IClusterable, IIndexedParameters, INamedP
 		return this;
 	}
 
+	/**
+	 * Adds a page parameter to these with {@code name} and {@code value}
+	 * 
+	 * @param name
+	 * @param value
+	 * @return these
+	 */
 	public PageParameters add(final String name, final Object value)
 	{
 		return add(name, value, Type.MANUAL);
@@ -321,6 +328,14 @@ public class PageParameters implements IClusterable, IIndexedParameters, INamedP
 		return this;
 	}
 
+	/**
+	 * Sets the page parameter with {@code name} and {@code value} at the given {@code index}
+	 * 
+	 * @param name
+	 * @param value
+	 * @param index
+	 * @return this
+	 */
 	public PageParameters set(final String name, final Object value, final int index)
 	{
 		return set(name, value, index, Type.MANUAL);
@@ -338,6 +353,13 @@ public class PageParameters implements IClusterable, IIndexedParameters, INamedP
 		return this;
 	}
 
+	/**
+	 * Sets the page parameter with {@code name} and {@code value}
+	 * 
+	 * @param name
+	 * @param value
+	 * @return this
+	 */
 	public PageParameters set(final String name, final Object value)
 	{
 		return set(name, value, Type.MANUAL);

http://git-wip-us.apache.org/repos/asf/wicket/blob/741a2196/wicket-request/src/test/java/org/apache/wicket/request/HttpHeaderCollectionTest.java
----------------------------------------------------------------------
diff --git a/wicket-request/src/test/java/org/apache/wicket/request/HttpHeaderCollectionTest.java b/wicket-request/src/test/java/org/apache/wicket/request/HttpHeaderCollectionTest.java
index c358704..4b85c35 100644
--- a/wicket-request/src/test/java/org/apache/wicket/request/HttpHeaderCollectionTest.java
+++ b/wicket-request/src/test/java/org/apache/wicket/request/HttpHeaderCollectionTest.java
@@ -30,6 +30,7 @@ import java.util.TimeZone;
 import org.apache.wicket.util.time.Time;
 import org.junit.Test;
 
+@SuppressWarnings("javadoc")
 public class HttpHeaderCollectionTest
 {
 	@Test

http://git-wip-us.apache.org/repos/asf/wicket/blob/741a2196/wicket-request/src/test/java/org/apache/wicket/request/UrlTest.java
----------------------------------------------------------------------
diff --git a/wicket-request/src/test/java/org/apache/wicket/request/UrlTest.java b/wicket-request/src/test/java/org/apache/wicket/request/UrlTest.java
index 75db0d6..b2ef9a5 100644
--- a/wicket-request/src/test/java/org/apache/wicket/request/UrlTest.java
+++ b/wicket-request/src/test/java/org/apache/wicket/request/UrlTest.java
@@ -18,6 +18,7 @@ package org.apache.wicket.request;
 
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.CoreMatchers.nullValue;
+import static org.junit.Assert.*;
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
@@ -31,14 +32,10 @@ import java.util.List;
 
 import org.apache.wicket.request.Url.QueryParameter;
 import org.apache.wicket.request.Url.StringMode;
-import org.junit.Assert;
 import org.junit.Test;
 
-/**
- * @author Matej Knopp
- * @author Igor Vaynberg
- */
-public class UrlTest extends Assert
+@SuppressWarnings("javadoc")
+public class UrlTest
 {
 	private void checkSegments(Url url, String... segments)
 	{
@@ -57,9 +54,6 @@ public class UrlTest extends Assert
 		assertEquals(list, url.getQueryParameters());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parse1()
 	{
@@ -70,9 +64,6 @@ public class UrlTest extends Assert
 		assertEquals("foo2", url.getFragment());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parse2()
 	{
@@ -82,9 +73,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url, "", "4", "6", "");
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parse3()
 	{
@@ -97,9 +85,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parse4()
 	{
@@ -110,9 +95,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parse5()
 	{
@@ -135,9 +117,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url, "a", "b", "x?&4", "y=z");
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parse6()
 	{
@@ -147,9 +126,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parse7()
 	{
@@ -159,9 +135,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url, "a", "b");
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parse8()
 	{
@@ -172,9 +145,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parse9()
 	{
@@ -185,9 +155,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url, "a", "b");
 	}
 
-	/**
-	 *
-	 */
 	@Test
 	public void parse10()
 	{
@@ -198,9 +165,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url, "a", "");
 	}
 
-	/**
-	 *
-	 */
 	@Test
 	public void parse11()
 	{
@@ -211,9 +175,6 @@ public class UrlTest extends Assert
 		checkQueryParams(url, "a", "");
 	}
 
-	/**
-	 *
-	 */
 	@Test
 	public void parse12()
 	{
@@ -335,9 +296,6 @@ public class UrlTest extends Assert
 		assertThat(url.getFragment(), is(nullValue()));
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void render1()
 	{
@@ -352,9 +310,6 @@ public class UrlTest extends Assert
 		assertEquals("foo/b=r/b&z/x%3F?a=b&x%3F%264=y%3Dz", url.toString());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void render2()
 	{
@@ -363,9 +318,6 @@ public class UrlTest extends Assert
 		assertEquals(url.toString(), s);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void render3()
 	{
@@ -374,9 +326,6 @@ public class UrlTest extends Assert
 		assertEquals(url.toString(StringMode.FULL), s);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void render4()
 	{
@@ -412,9 +361,6 @@ public class UrlTest extends Assert
 		assertEquals("https://www.domain.com/foo/bar?baz=ban#bat", url.toString(StringMode.FULL));
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void absolute1()
 	{
@@ -423,9 +369,6 @@ public class UrlTest extends Assert
 		assertFalse(url.isContextAbsolute());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void absolute2()
 	{
@@ -434,9 +377,6 @@ public class UrlTest extends Assert
 		assertFalse(url.isContextAbsolute());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void absolute3()
 	{
@@ -445,9 +385,6 @@ public class UrlTest extends Assert
 		assertTrue(url.isContextAbsolute());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void absolute4()
 	{
@@ -456,9 +393,6 @@ public class UrlTest extends Assert
 		assertTrue(url.isContextAbsolute());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void absolute5()
 	{
@@ -468,9 +402,6 @@ public class UrlTest extends Assert
 	}
 
 
-	/**
-	 * 
-	 */
 	@Test
 	public void concat1()
 	{
@@ -479,9 +410,6 @@ public class UrlTest extends Assert
 		assertEquals(Url.parse("abc/xx/yy"), url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void concat2()
 	{
@@ -490,9 +418,6 @@ public class UrlTest extends Assert
 		assertEquals(Url.parse("xx/yy"), url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void concat3()
 	{
@@ -501,9 +426,6 @@ public class UrlTest extends Assert
 		assertEquals(Url.parse("xx/yy"), url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void concat4()
 	{
@@ -512,9 +434,6 @@ public class UrlTest extends Assert
 		assertEquals(Url.parse("../xx/yy"), url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void concat5()
 	{
@@ -523,9 +442,6 @@ public class UrlTest extends Assert
 		assertEquals(Url.parse("abc/efg/xx/yy"), url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void concat6()
 	{
@@ -534,9 +450,6 @@ public class UrlTest extends Assert
 		assertEquals(Url.parse("abc/"), url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void concat7()
 	{
@@ -545,9 +458,6 @@ public class UrlTest extends Assert
 		assertEquals(Url.parse(""), url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void concat8()
 	{
@@ -556,9 +466,6 @@ public class UrlTest extends Assert
 		assertEquals(Url.parse("fff/abc/"), url);
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void concat9()
 	{
@@ -746,9 +653,6 @@ public class UrlTest extends Assert
 		return (Url)ois.readObject();
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parseRelativeUrl()
 	{
@@ -775,9 +679,6 @@ public class UrlTest extends Assert
 		assertTrue(url.isContextAbsolute());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void parseAbsoluteUrl()
 	{
@@ -921,9 +822,6 @@ public class UrlTest extends Assert
 
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void prependLeadingSegments1()
 	{
@@ -934,9 +832,6 @@ public class UrlTest extends Assert
 		assertEquals("x/y/a", url.toString());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void prependLeadingSegments2()
 	{
@@ -947,9 +842,6 @@ public class UrlTest extends Assert
 		assertEquals("x/a", url.toString());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void prependLeadingSegments3()
 	{
@@ -960,9 +852,6 @@ public class UrlTest extends Assert
 		assertEquals("a", url.toString());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void prependLeadingSegments4()
 	{
@@ -973,9 +862,6 @@ public class UrlTest extends Assert
 		assertEquals("x", url.toString());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void removeLeadingSegments1()
 	{
@@ -985,9 +871,6 @@ public class UrlTest extends Assert
 		assertEquals("b", url.toString());
 	}
 
-	/**
-	 * 
-	 */
 	@Test
 	public void removeLeadingSegments2()
 	{
@@ -997,9 +880,6 @@ public class UrlTest extends Assert
 		assertEquals("", url.toString());
 	}
 
-	/**
-	 * 
-	 */
 	@Test(expected = IllegalArgumentException.class)
 	public void removeLeadingSegments3()
 	{
@@ -1099,5 +979,4 @@ public class UrlTest extends Assert
 		checkUrl(url, "http", "[::1]", 1234, "", "myapp");
 		
 	}
-
 }