Merge pull request #662 from kazuki43zoo/issues/661_cursor-on-annotaion-based-mapper

Support Cursor on annotation based Mapper interface #661

Author: emacarron

src/main/java/org/apache/ibatis/builder/annotation/MapperAnnotationBuilder.java

@@ -62,6 +62,7 @@
 import org.apache.ibatis.builder.IncompleteElementException;
 import org.apache.ibatis.builder.MapperBuilderAssistant;
 import org.apache.ibatis.builder.xml.XMLMapperBuilder;
+import org.apache.ibatis.cursor.Cursor;
 import org.apache.ibatis.executor.keygen.Jdbc3KeyGenerator;
 import org.apache.ibatis.executor.keygen.KeyGenerator;
 import org.apache.ibatis.executor.keygen.NoKeyGenerator;
@@ -390,7 +391,7 @@ private Class<?> getReturnType(Method method) {
     } else if (resolvedReturnType instanceof ParameterizedType) {
       ParameterizedType parameterizedType = (ParameterizedType) resolvedReturnType;
       Class<?> rawType = (Class<?>) parameterizedType.getRawType();
-      if (Collection.class.isAssignableFrom(rawType)) {
+      if (Collection.class.isAssignableFrom(rawType) || Cursor.class.isAssignableFrom(rawType)) {
         Type[] actualTypeArguments = parameterizedType.getActualTypeArguments();
         if (actualTypeArguments != null && actualTypeArguments.length == 1) {
           Type returnTypeParameter = actualTypeArguments[0];

src/test/java/org/apache/ibatis/submitted/cursor_simple/AnnotationMapper.java

@@ -0,0 +1,26 @@
+/**
+ *    Copyright 2009-2016 the original author or authors.
+ *
+ *    Licensed 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.ibatis.submitted.cursor_simple;
+
+import org.apache.ibatis.annotations.Select;
+import org.apache.ibatis.cursor.Cursor;
+
+public interface AnnotationMapper {
+
+  @Select("select * from users order by id")
+  Cursor<User> getAllUsers();
+
+}

src/test/java/org/apache/ibatis/submitted/cursor_simple/CursorSimpleTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 the original author or authors.
+ *    Copyright 2009-2016 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -30,7 +30,9 @@
 import java.io.IOException;
 import java.io.Reader;
 import java.sql.Connection;
+import java.util.ArrayList;
 import java.util.Iterator;
+import java.util.List;
 
 public class CursorSimpleTest {
 
@@ -294,4 +296,41 @@ public void testCursorUsageAfterClose() throws IOException {
 
         Assert.fail("Should have returned earlier");
     }
+
+    @Test
+    public void shouldGetAllUserUsingAnnotationBasedMapper() {
+        SqlSession sqlSession = sqlSessionFactory.openSession();
+        sqlSession.getConfiguration().getMapperRegistry().addMapper(AnnotationMapper.class);
+        AnnotationMapper mapper = sqlSession.getMapper(AnnotationMapper.class);
+        Cursor<User> usersCursor = mapper.getAllUsers();
+        try {
+            Assert.assertFalse(usersCursor.isOpen());
+            Assert.assertFalse(usersCursor.isConsumed());
+            Assert.assertEquals(-1, usersCursor.getCurrentIndex());
+
+            List<User> userList = new ArrayList<User>();
+            for (User user : usersCursor){
+                userList.add(user);
+                Assert.assertEquals(userList.size() -1, usersCursor.getCurrentIndex());
+            }
+
+            Assert.assertFalse(usersCursor.isOpen());
+            Assert.assertTrue(usersCursor.isConsumed());
+            Assert.assertEquals(3, usersCursor.getCurrentIndex());
+
+            Assert.assertEquals(4, userList.size());
+            User user = userList.get(0);
+            Assert.assertEquals("User1", user.getName());
+            user = userList.get(1);
+            Assert.assertEquals("User2", user.getName());
+            user = userList.get(2);
+            Assert.assertEquals("User3", user.getName());
+            user = userList.get(3);;
+            Assert.assertEquals("User4", user.getName());
+
+        } finally {
+            sqlSession.close();
+        }
+    }
+
 }