New test case to show how to use enum constants in mapped statements

Author: mnesarco

src/test/java/mybatis-velocity.properties

@@ -1,2 +1,2 @@
-additional.context.attributes=trailingWildCardFormatter:org.mybatis.scripting.velocity.use.TrailingWildCardFormatter
+additional.context.attributes=trailingWildCardFormatter:org.mybatis.scripting.velocity.use.TrailingWildCardFormatter,enumBinder:org.mybatis.scripting.velocity.use.EnumBinder
 userdirective=org.mybatis.scripting.velocity.use.CustomUserDirective

src/test/java/org/mybatis/scripting/velocity/use/EnumBinder.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2013 MyBatis.org.
+ *
+ * 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.mybatis.scripting.velocity.use;
+
+/**
+ *
+ * @author mnesarco
+ */
+public class EnumBinder {
+  
+  public EnumWrapper bind(String className) throws ClassNotFoundException {
+    return new EnumWrapper(Class.forName(className));
+  }
+  
+}

src/test/java/org/mybatis/scripting/velocity/use/EnumWrapper.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2013 MyBatis.org.
+ *
+ * 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.mybatis.scripting.velocity.use;
+
+import java.util.HashMap;
+
+/**
+ *
+ * @author mnesarco
+ */
+public class EnumWrapper extends HashMap<String, Integer> {
+
+  public EnumWrapper(Class<?> e) {
+    if (e.isEnum()) {
+      Object[] consts = e.getEnumConstants();
+      for (int i = 0; i<consts.length; i++) {
+        put(consts[i].toString(), i);
+      }
+    }
+    else {
+      throw new IllegalArgumentException("Supplied argument is not an enum class");
+    }
+  }
+  
+}

src/test/java/org/mybatis/scripting/velocity/use/VelocityLanguageTest.java

@@ -39,6 +39,10 @@ public class VelocityLanguageTest {
 
   protected static SqlSessionFactory sqlSessionFactory;
 
+  public enum IDS {
+    ZERO, ONE, TWO, THREE, FOUR, FIVE
+  }
+  
   @BeforeClass
   public static void setUp() throws Exception {
     Connection conn = null;
@@ -145,6 +149,22 @@ public void testSelectNamesWithFormattedParam() {
     }
   }
 
+  @Test
+  public void testEnumBinding() {
+    SqlSession sqlSession = sqlSessionFactory.openSession();
+    try {
+
+      List<Name> answer = sqlSession.selectList("org.mybatis.scripting.velocity.use.selectEnumBinding");
+      assertEquals(3, answer.size());
+      for (Name n : answer) {
+        assertEquals("Flintstone", n.getLastName());
+      }
+
+    } finally {
+      sqlSession.close();
+    }
+  }
+
   @Test
   public void testSelectNamesWithFormattedParamSafe() {
     SqlSession sqlSession = sqlSessionFactory.openSession();

src/test/java/org/mybatis/scripting/velocity/use/mapper.xml

@@ -107,4 +107,12 @@
     VALUES (@{firstName}, @{lastName})
   </insert>
 
+  <select id="selectEnumBinding" resultType="org.mybatis.scripting.velocity.use.Name">
+    #set( $ids = $enumBinder.bind('org.mybatis.scripting.velocity.use.VelocityLanguageTest$IDS') )
+    SELECT *
+    FROM names
+       WHERE 
+        id IN (@{ids.ONE}, @{ids.TWO}, @{ids.THREE})
+  </select>
+
 </mapper>