Merge pull request #25 from hazendaz/master

[ci] Cleanup issues per checkstyle

Author: hazendaz

src/main/java/org/mybatis/scripting/freemarker/FreeMarkerLanguageDriver.java

@@ -18,6 +18,12 @@
 import freemarker.cache.ClassTemplateLoader;
 import freemarker.cache.TemplateLoader;
 import freemarker.template.Template;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.StringReader;
+import java.util.Properties;
+
 import org.apache.ibatis.executor.parameter.ParameterHandler;
 import org.apache.ibatis.mapping.BoundSql;
 import org.apache.ibatis.mapping.MappedStatement;
@@ -27,11 +33,6 @@
 import org.apache.ibatis.scripting.defaults.DefaultParameterHandler;
 import org.apache.ibatis.session.Configuration;
 
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.StringReader;
-import java.util.Properties;
-
 /**
  * Adds FreeMarker templates support to scripting in MyBatis.
  * If you want to change or extend template loader configuration, use can
@@ -71,7 +72,30 @@ public FreeMarkerLanguageDriver() {
   }
 
   /**
-   * Creates a {@link ParameterHandler} that passes the actual parameters to the the JDBC statement.
+   * Creates the {@link freemarker.template.Configuration} instance
+   * and sets it up. If you want to change it (set another props, for
+   * example), you can override it in inherited class and use your own
+   * class in @Lang directive.
+   */
+  protected freemarker.template.Configuration createFreeMarkerConfiguration() {
+    freemarker.template.Configuration cfg = new freemarker.template.Configuration(
+        freemarker.template.Configuration.VERSION_2_3_22);
+
+    TemplateLoader templateLoader = new ClassTemplateLoader(this.getClass().getClassLoader(), basePackage);
+    cfg.setTemplateLoader(templateLoader);
+
+    // To avoid formatting numbers using spaces and commas in SQL
+    cfg.setNumberFormat("computer");
+
+    // Because it defaults to default system encoding, we should set it always explicitly
+    cfg.setDefaultEncoding("utf-8");
+
+    return cfg;
+  }
+
+  /**
+   * Creates a {@link ParameterHandler} that passes the actual parameters
+   * to the the JDBC statement.
    *
    * @see DefaultParameterHandler
    * @param mappedStatement The mapped statement that is being executed
@@ -86,52 +110,35 @@ public ParameterHandler createParameterHandler(MappedStatement mappedStatement,
   }
 
   /**
-   * Creates an {@link SqlSource} that will hold the statement read from a mapper xml file.
-   * It is called during startup, when the mapped statement is read from a class or an xml file.
+   * Creates an {@link SqlSource} that will hold the statement read
+   * from a mapper xml file. It is called during startup, when the
+   * mapped statement is read from a class or an xml file.
    *
    * @param configuration The MyBatis configuration
    * @param script XNode parsed from a XML file
-   * @param parameterType input parameter type got from a mapper method or specified in the parameterType xml attribute. Can be null.
+   * @param parameterType input parameter type got from a mapper method
+   *        or specified in the parameterType xml attribute. Can be null.
    */
   @Override
   public SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType) {
     return createSqlSource(configuration, script.getNode().getTextContent());
   }
 
   /**
-   * Creates an {@link SqlSource} that will hold the statement read from an annotation.
-   * It is called during startup, when the mapped statement is read from a class or an xml file.
+   * Creates an {@link SqlSource} that will hold the statement read
+   * from an annotation. It is called during startup, when the mapped
+   * statement is read from a class or an xml file.
    *
    * @param configuration The MyBatis configuration
    * @param script The content of the annotation
-   * @param parameterType input parameter type got from a mapper method or specified in the parameterType xml attribute. Can be null.
+   * @param parameterType input parameter type got from a mapper method
+   *        or specified in the parameterType xml attribute. Can be null.
    */
   @Override
   public SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType) {
     return createSqlSource(configuration, script);
   }
 
-  /**
-   * Creates the {@link freemarker.template.Configuration} instance and sets it up.
-   * If you want to change it (set another props, for example), you can override it in
-   * inherited class and use your own class in @Lang directive.
-   */
-  protected freemarker.template.Configuration createFreeMarkerConfiguration() {
-    freemarker.template.Configuration cfg = new freemarker.template.Configuration(
-        freemarker.template.Configuration.VERSION_2_3_22);
-
-    TemplateLoader templateLoader = new ClassTemplateLoader(this.getClass().getClassLoader(), basePackage);
-    cfg.setTemplateLoader(templateLoader);
-
-    // To avoid formatting numbers using spaces and commas in SQL
-    cfg.setNumberFormat("computer");
-
-    // Because it defaults to default system encoding, we should set it always explicitly
-    cfg.setDefaultEncoding("utf-8");
-
-    return cfg;
-  }
-
   protected SqlSource createSqlSource(Template template, Configuration configuration) {
     return new FreeMarkerSqlSource(template, configuration);
   }
@@ -156,4 +163,5 @@ private SqlSource createSqlSource(Configuration configuration, String scriptText
 
     return createSqlSource(template, configuration);
   }
+
 }

src/main/java/org/mybatis/scripting/freemarker/FreeMarkerSqlSource.java

@@ -17,20 +17,22 @@
 
 import freemarker.template.Template;
 import freemarker.template.TemplateException;
-import org.apache.ibatis.builder.SqlSourceBuilder;
-import org.apache.ibatis.mapping.BoundSql;
-import org.apache.ibatis.mapping.SqlSource;
-import org.apache.ibatis.session.Configuration;
 
 import java.io.CharArrayWriter;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
 
+import org.apache.ibatis.builder.SqlSourceBuilder;
+import org.apache.ibatis.mapping.BoundSql;
+import org.apache.ibatis.mapping.SqlSource;
+import org.apache.ibatis.session.Configuration;
+
 /**
  * Applies provided parameter(s) to FreeMarker template.
- * Then passes the result into default MyBatis engine (and it finally replaces #{}-params to '?'-params).
+ * Then passes the result into default MyBatis engine
+ * (and it finally replaces #{}-params to '?'-params).
  * So, FreeMarker is used as preprocessor for MyBatis engine.
  *
  * @author elwood
@@ -39,7 +41,7 @@ public class FreeMarkerSqlSource implements SqlSource {
   private final Template template;
   private final Configuration configuration;
 
-  public final static String GENERATED_PARAMS_KEY = "__GENERATED__";
+  public static final String GENERATED_PARAMS_KEY = "__GENERATED__";
 
   public FreeMarkerSqlSource(Template template, Configuration configuration) {
     this.template = template;
@@ -48,7 +50,9 @@ public FreeMarkerSqlSource(Template template, Configuration configuration) {
 
   /**
    * Populates additional parameters to data context.
-   * Data context can be {@link java.util.Map} or {@link org.mybatis.scripting.freemarker.ParamObjectAdapter} instance.
+   * Data context can be {@link java.util.Map}
+   * or {@link org.mybatis.scripting.freemarker.ParamObjectAdapter}
+   * instance.
    */
   protected Object preProcessDataContext(Object dataContext, boolean isMap) {
     if (isMap) {
@@ -65,7 +69,7 @@ public BoundSql getBoundSql(Object parameterObject) {
     // Add to passed parameterObject our predefined directive - MyBatisParamDirective
     // It will be available as "p" inside templates
     Object dataContext;
-    ArrayList generatedParams = new ArrayList();
+    ArrayList generatedParams = new ArrayList<>();
     if (parameterObject != null) {
       if (parameterObject instanceof Map) {
         HashMap<String, Object> map = new HashMap<>((Map<String, Object>) parameterObject);
@@ -88,14 +92,15 @@ public BoundSql getBoundSql(Object parameterObject) {
       throw new RuntimeException(e);
     }
 
-    // We got SQL ready for MyBatis here. This SQL contains params declarations like "#{param}",
+    // We got SQL ready for MyBatis here. This SQL contains
+    // params declarations like "#{param}",
     // they will be replaced to '?' by MyBatis engine further
     String sql = writer.toString();
 
     if (!generatedParams.isEmpty()) {
       if (!(parameterObject instanceof Map)) {
         throw new UnsupportedOperationException("Auto-generated prepared statements parameters"
-            + " are not available if using parameters object. Use @Param-annotated parameters instead.");
+            + " are not available if using parameters object. Use @Param-annotated parameters" + " instead.");
       }
 
       Map<String, Object> parametersMap = (Map<String, Object>) parameterObject;

src/main/java/org/mybatis/scripting/freemarker/MyBatisParamDirective.java

@@ -17,7 +17,16 @@
 
 import freemarker.core.Environment;
 import freemarker.ext.util.WrapperTemplateModel;
-import freemarker.template.*;
+import freemarker.template.DefaultListAdapter;
+import freemarker.template.SimpleScalar;
+import freemarker.template.TemplateBooleanModel;
+import freemarker.template.TemplateDateModel;
+import freemarker.template.TemplateDirectiveBody;
+import freemarker.template.TemplateDirectiveModel;
+import freemarker.template.TemplateException;
+import freemarker.template.TemplateModel;
+import freemarker.template.TemplateNumberModel;
+import freemarker.template.TemplateScalarModel;
 
 import java.io.IOException;
 import java.util.List;
@@ -33,8 +42,10 @@
  *     <@p name="paramName"/>
  * </pre></blockquote>
  *
+ * <p>
  * Also directive supports `value` attribute. If it is specified, param will take passed value
  * and create the corresponding #{}-parameter. This is useful in loops:
+ * </p>
  *
  * <blockquote><pre>
  *     &lt;#list ids as id&gt;
@@ -43,13 +54,17 @@
  *     &lt;/#list&gt;
  * </pre></blockquote>
  *
+ * <p>
  * will be translated into
+ * </p>
  *
  * <blockquote><pre>
  *     #{_p0},#{_p1},#{_p2}
  * </pre></blockquote>
  *
+ * <p>
  * And MyBatis engine will convert it to `?`-params finally.
+ * </p>
  *
  * @author elwood
  */

src/main/java/org/mybatis/scripting/freemarker/ParamObjectAdapter.java

@@ -17,7 +17,10 @@
 
 import freemarker.ext.beans.BeanModel;
 import freemarker.ext.beans.BeansWrapperBuilder;
-import freemarker.template.*;
+import freemarker.template.Configuration;
+import freemarker.template.TemplateHashModel;
+import freemarker.template.TemplateModel;
+import freemarker.template.TemplateModelException;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -44,8 +47,9 @@ public ParamObjectAdapter(Object paramObject, ArrayList generatedParams) {
    * custom objects and directives into dataContext.
    */
   public void putAdditionalParam(String key, TemplateModel value) {
-    if (additionalParams == null)
+    if (additionalParams == null) {
       additionalParams = new HashMap<>();
+    }
     additionalParams.put(key, value);
   }
 

src/test/java/org/mybatis/scripting/freemarker/FreeMarkerInAnnotationsTest.java

@@ -95,6 +95,7 @@ public void testInQuery() {
     try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
       NameMapper mapper = sqlSession.getMapper(NameMapper.class);
       List<Name> namesByIds = mapper.findNamesByIds(new ArrayList<Integer>() {
+        private static final long serialVersionUID = 1L;
         {
           add(1);
           add(3);

src/test/java/org/mybatis/scripting/freemarker/FreeMarkerInXmlTest.java

@@ -89,6 +89,7 @@ public void testInQuery() {
     try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
       HashMap<String, Object> paramsMap = new HashMap<>();
       paramsMap.put("ids", new ArrayList<Integer>() {
+        private static final long serialVersionUID = 1L;
         {
           add(1);
           add(3);

src/test/java/org/mybatis/scripting/freemarker/PreparedParamsTest.java

@@ -78,6 +78,7 @@ public void testInCall() {
     try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
       PreparedParamsMapper mapper = sqlSession.getMapper(PreparedParamsMapper.class);
       List<Name> names = mapper.findByNames(new ArrayList<String>() {
+        private static final long serialVersionUID = 1L;
         {
           add("Pebbles");
           add("Barney");