Merge commit 'origin/master' into key-tags

build.gradle

@@ -1,7 +1,7 @@
 apply plugin: 'java'
 apply plugin: 'maven'
 
-group = 'redis.clients'
+group = 'com.googlecode.jedis'
 archiveBaseName = 'jedis'
 version = '1.2.0'
 

pom.xml

@@ -1,8 +1,46 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+	<parent>
+		<groupId>org.sonatype.oss</groupId>
+		<artifactId>oss-parent</artifactId>
+		<version>5</version>
+	</parent>
+
 	<modelVersion>4.0.0</modelVersion>
-  <groupId>redis.clients</groupId>
+	<packaging>jar</packaging>
+
+	<groupId>com.googlecode.jedis</groupId>
 	<artifactId>jedis</artifactId>
 	<version>1.2.0</version>
+
+	<name>Jedis</name>
+	<description>Jedis is a blazingly small and sane Redis java client.</description>
+	<url>http://code.google.com/p/jedis/</url>
+
+	<licenses>
+		<license>
+			<name>Jedis License</name>
+			<url>http://github.com/xetorthio/jedis/raw/master/LICENSE.txt</url>
+			<distribution>repo</distribution>
+		</license>
+	</licenses>
+
+	<issueManagement>
+		<system>github</system>
+		<url>http://github.com/xetorthio/jedis/issues</url>
+	</issueManagement>
+
+	<scm>
+		<url>http://github.com/xetorthio/jedis</url>
+		<connection>scm:git:http://github.com/xetorthio/jedis.git</connection>
+		<developerConnection>scm:git:http://github.com/xetorthio/jedis.git</developerConnection>
+	</scm>
+
+	<properties>
+		<redis-hosts>localhost:6379,localhost:6380</redis-hosts>
+	</properties>
+
 	<dependencies>
 		<dependency>
 			<groupId>junit</groupId>
@@ -13,10 +51,6 @@
 		</dependency>
 	</dependencies>
 
-  <properties>
-  	<redis-hosts>localhost:6379,localhost:6380</redis-hosts>
-  </properties>
-  
 	<build>
 		<plugins>
 			<plugin>

src/main/java/redis/clients/jedis/SortingParams.java

@@ -5,29 +5,77 @@ import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 
+/**
+ * Builder Class for {@link Jedis#sort(String, SortingParams) SORT} Parameters.
+ * 
+ */
 public class SortingParams {
 	private List<String> params = new ArrayList<String>();
 
+	/**
+	 * Sort by weight in keys.
+	 * <p>
+	 * Takes a pattern that is used in order to generate the key names of the
+	 * weights used for sorting. Weight key names are obtained substituting the
+	 * first occurrence of * with the actual value of the elements on the list.
+	 * <p>
+	 * The pattern for a normal key/value pair is "keyname*" and for a value in
+	 * a hash "keyname*->fieldname".
+	 * 
+	 * @param pattern
+	 * @return the SortingParams Object
+	 */
 	public SortingParams by(String pattern) {
 		params.add("BY");
 		params.add(pattern);
 		return this;
 	}
 
+	/**
+	 * No sorting.
+	 * <p>
+	 * This is useful if you want to retrieve a external key (using
+	 * {@link #get(String...) GET}) but you don't want the sorting overhead.
+	 * 
+	 * @return the SortingParams Object
+	 */
+	public SortingParams nosort() {
+		params.add("BY nosort");
+		return this;
+	}
+
 	public Collection<String> getParams() {
 		return Collections.unmodifiableCollection(params);
 	}
 
+	/**
+	 * Get the Sorting in Descending Order.
+	 * 
+	 * @return the sortingParams Object
+	 */
 	public SortingParams desc() {
 		params.add("DESC");
 		return this;
 	}
 
+	/**
+	 * Get the Sorting in Ascending Order. This is the default order.
+	 * 
+	 * @return the SortingParams Object
+	 */
 	public SortingParams asc() {
 		params.add("ASC");
 		return this;
 	}
 
+	/**
+	 * Limit the Numbers of returned Elements.
+	 * 
+	 * @param start
+	 *            is zero based
+	 * @param count
+	 * @return the SortingParams Object
+	 */
 	public SortingParams limit(int start, int count) {
 		params.add("LIMIT");
 		params.add(String.valueOf(start));
@@ -35,11 +83,32 @@ public class SortingParams {
 		return this;
 	}
 
+	/**
+	 * Sort lexicographicaly. Note that Redis is utf-8 aware assuming you set
+	 * the right value for the LC_COLLATE environment variable.
+	 * 
+	 * @return the SortingParams Object
+	 */
 	public SortingParams alpha() {
 		params.add("ALPHA");
 		return this;
 	}
 
+	/**
+	 * Retrieving external keys from the result of the search.
+	 * <p>
+	 * Takes a pattern that is used in order to generate the key names of the
+	 * result of sorting. The key names are obtained substituting the
+	 * first occurrence of * with the actual value of the elements on the list.
+	 * <p>
+	 * The pattern for a normal key/value pair is "keyname*" and for a value in
+	 * a hash "keyname*->fieldname".
+	 * <p>
+	 * To get the list itself use the char # as pattern. 
+	 * 
+	 * @param patterns
+	 * @return the SortingParams Object
+	 */
 	public SortingParams get(String... patterns) {
 		for (String pattern : patterns) {
 			params.add("GET");