JERSEY-2486: Clarify Javadoc of PatternWithGroups.getGroupIndexes()

 - updated javadoc
 - UriTemplateParser.getGroupIndexes now returns non-empty array in
   case no nested capturing groups are used in a template
 - test

Change-Id: Ie09b1da069b3dfcb2f7dc1a66b844fb8c1519019
Signed-off-by: Michal Gajdos <[email protected]>

Author: Michal Gajdos

core-common/src/main/java/org/glassfish/jersey/uri/PatternWithGroups.java

@@ -147,9 +147,13 @@ public final String getRegex() {
     }
 
     /**
-     * Get the group indexes.
+     * Get the group indexes to capturing groups.
+     * <p>
+     * Any nested capturing groups will be ignored and the
+     * the group index will refer to the top-level capturing
+     * groups associated with the templates variables.
      *
-     * @return the group indexes.
+     * @return the group indexes to capturing groups.
      */
     public final int[] getGroupIndexes() {
         return groupIndexes.clone();

core-common/src/main/java/org/glassfish/jersey/uri/internal/UriTemplateParser.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2010-2013 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010-2014 Oracle and/or its affiliates. All rights reserved.
  *
  * The contents of this file are subject to the terms of either the GNU
  * General Public License Version 2 only ("GPL") or the Common Development
@@ -190,12 +190,7 @@ public final int[] getGroupIndexes() {
         for (int i = 1; i < indexes.length; i++) {
             indexes[i] = indexes[i - 1] + groupCounts.get(i - 1);
         }
-        for (int i = 0; i < indexes.length; i++) {
-            if (indexes[i] != i + 1) {
-                return indexes;
-            }
-        }
-        return EMPTY_INT_ARRAY;
+        return indexes;
     }
 
     /**

core-common/src/test/java/org/glassfish/jersey/uri/UriTemplateTest.java

@@ -58,7 +58,7 @@
 /**
  * Taken from Jersey 1: jersey-tests: com.sun.jersey.impl.uri.UriTemplateTest
  *
- * @author Paul.Sandoz at Sun.Com
+ * @author Paul Sandoz
  */
 public class UriTemplateTest {
 
@@ -398,6 +398,39 @@ public void testSubstitutionArray() {
                 "fred", "barney", "joe");
     }
 
+    @Test
+    public void testGroupIndexes() throws Exception {
+        UriTemplate template = new UriTemplate("/a");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[0]));
+
+        template = new UriTemplate("/{a}");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[] {1, 2}));
+
+        template = new UriTemplate("/{a}/b");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[] {1, 2}));
+
+        template = new UriTemplate("/{a}/{b}");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[] {1, 2, 3}));
+
+        template = new UriTemplate("/{a}/{b}");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[] {1, 2, 3}));
+
+        template = new UriTemplate("/{a}/b/{c}");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[] {1, 2, 3}));
+
+        template = new UriTemplate("/{a: (abc)+}");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[] {1, 3}));
+
+        template = new UriTemplate("/{a: (abc)+}/b");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[] {1, 3}));
+
+        template = new UriTemplate("/{a: (abc)+}/{b}");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[] {1, 3, 4}));
+
+        template = new UriTemplate("/{a: (abc)+}/b/{c}");
+        assertThat(template.getPattern().getGroupIndexes(), equalTo(new int[] {1, 3, 4}));
+    }
+
     void _testSubstitutionArray(String template, String uri, String... values) {
         UriTemplate t = new UriTemplate(template);