[ci] Add format.xml and allow auto formatting to mybatis rules

mybatis · May 22, 2017 · c20baeb · c20baeb
1 parent d221828
commit c20baeb
Show file tree

Hide file tree

Showing 16 changed files with 647 additions and 619 deletions.
diff --git a/format.xml b/format.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+       Copyright 2015-2017 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.
+
+-->
+<!DOCTYPE Format>
+<Format>
+ <!-- Dummy format file -->
+</Format>
diff --git a/src/main/java/org/mybatis/scripting/freemarker/FreeMarkerLanguageDriver.java b/src/main/java/org/mybatis/scripting/freemarker/FreeMarkerLanguageDriver.java
@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015 the original author or authors.
+ *    Copyright 2015-2017 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.
@@ -40,118 +40,120 @@
  * @author elwood
  */
 public class FreeMarkerLanguageDriver implements LanguageDriver {
-    /**
-     * Base package for all FreeMarker templates.
-     */
-    public static final String basePackage;
-
-    public static final String DEFAULT_BASE_PACKAGE = "";
-
-    static {
-        Properties properties = new Properties();
-        try {
-            try (InputStream stream = FreeMarkerLanguageDriver.class.getClassLoader()
-                    .getResourceAsStream("mybatis-freemarker.properties")) {
-                if (stream != null) {
-                    properties.load(stream);
-                    basePackage = properties.getProperty("basePackage", DEFAULT_BASE_PACKAGE);
-                } else {
-                    basePackage = DEFAULT_BASE_PACKAGE;
-                }
-            }
-        } catch (IOException e) {
-            throw new IllegalStateException(e);
+  /**
+   * Base package for all FreeMarker templates.
+   */
+  public static final String basePackage;
+
+  public static final String DEFAULT_BASE_PACKAGE = "";
+
+  static {
+    Properties properties = new Properties();
+    try {
+      try (InputStream stream = FreeMarkerLanguageDriver.class.getClassLoader()
+          .getResourceAsStream("mybatis-freemarker.properties")) {
+        if (stream != null) {
+          properties.load(stream);
+          basePackage = properties.getProperty("basePackage", DEFAULT_BASE_PACKAGE);
+        } else {
+          basePackage = DEFAULT_BASE_PACKAGE;
         }
+      }
+    } catch (IOException e) {
+      throw new IllegalStateException(e);
     }
-
-    protected freemarker.template.Configuration freemarkerCfg;
-
-    public FreeMarkerLanguageDriver() {
-        freemarkerCfg = createFreeMarkerConfiguration();
-    }
-
-    /**
-     * 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
-     * @param parameterObject The input parameter object (can be null)
-     * @param boundSql The resulting SQL once the dynamic language has been executed.
-     */
-    @Override
-    public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
-        // As default XMLLanguageDriver
-        return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql);
+  }
+
+  protected freemarker.template.Configuration freemarkerCfg;
+
+  public FreeMarkerLanguageDriver() {
+    freemarkerCfg = createFreeMarkerConfiguration();
+  }
+
+  /**
+   * 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
+   * @param parameterObject The input parameter object (can be null)
+   * @param boundSql The resulting SQL once the dynamic language has been executed.
+   */
+  @Override
+  public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject,
+      BoundSql boundSql) {
+    // As default XMLLanguageDriver
+    return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql);
+  }
+
+  /**
+   * 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.
+   */
+  @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.
+   *
+   * @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.
+   */
+  @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);
+  }
+
+  private SqlSource createSqlSource(Configuration configuration, String scriptText) {
+    Template template;
+    if (scriptText.trim().contains(" ")) {
+      // Consider that script is inline script
+      try {
+        template = new Template(null, new StringReader(scriptText), freemarkerCfg);
+      } catch (IOException e) {
+        throw new RuntimeException(e);
+      }
+    } else {
+      // Consider that script is template name, trying to find the template in classpath
+      try {
+        template = freemarkerCfg.getTemplate(scriptText.trim());
+      } catch (IOException e) {
+        throw new RuntimeException(e);
+      }
     }
 
-    /**
-     * 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.
-     */
-    @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.
-     *
-     * @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.
-     */
-    @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);
-    }
-
-    private SqlSource createSqlSource(Configuration configuration, String scriptText) {
-        Template template;
-        if (scriptText.trim().contains(" ")) {
-            // Consider that script is inline script
-            try {
-                template = new Template(null, new StringReader(scriptText), freemarkerCfg);
-            } catch (IOException e) {
-                throw new RuntimeException(e);
-            }
-        } else {
-            // Consider that script is template name, trying to find the template in classpath
-            try {
-                template = freemarkerCfg.getTemplate(scriptText.trim());
-            } catch (IOException e) {
-                throw new RuntimeException(e);
-            }
-        }
-
-        return createSqlSource(template, configuration);
-    }
+    return createSqlSource(template, configuration);
+  }
 }