[ci] Format javadocs

Author: hazendaz

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2017 the original author or authors.
+ *    Copyright 2015-2018 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.
@@ -35,9 +35,8 @@
 import org.apache.ibatis.session.Configuration;
 
 /**
- * Adds FreeMarker templates support to scripting in MyBatis.
- * If you want to change or extend template loader configuration, use can
- * inherit from this class and override {@link #createFreeMarkerConfiguration()} method.
+ * Adds FreeMarker templates support to scripting in MyBatis. If you want to change or extend template loader
+ * configuration, use can inherit from this class and override {@link #createFreeMarkerConfiguration()} method.
  *
  * @author elwood
  */
@@ -73,10 +72,8 @@ public FreeMarkerLanguageDriver() {
   }
 
   /**
-   * 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.
+   * 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(
@@ -95,13 +92,15 @@ protected freemarker.template.Configuration createFreeMarkerConfiguration() {
   }
 
   /**
-   * Creates a {@link ParameterHandler} that passes the actual parameters
-   * to the the JDBC statement.
+   * 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.
+   * @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,
@@ -111,29 +110,33 @@ 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 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.
+   * 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 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) {

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2017 the original author or authors.
+ *    Copyright 2015-2018 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,10 +30,8 @@
 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).
- * So, FreeMarker is used as preprocessor for MyBatis engine.
+ * Applies provided parameter(s) to FreeMarker template. 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
  */
@@ -49,10 +47,8 @@ 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.
+   * Populates additional parameters to data context. 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) {

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2017 the original author or authors.
+ *    Copyright 2015-2018 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.
@@ -33,34 +33,45 @@
 import java.util.Map;
 
 /**
- * Custom FreeMarker directive for generating "#{paramName}" declarations in convenient way.
- * Problem is FreeMarker supports this syntax natively and there are no chance to disable this
- * (although it is deprecated). And to get "#{paramName}" we should write ${r"#{paramName}"}.
- * With this directive you can write more simple:
+ * Custom FreeMarker directive for generating "#{paramName}" declarations in convenient way. Problem is FreeMarker
+ * supports this syntax natively and there are no chance to disable this (although it is deprecated). And to get
+ * "#{paramName}" we should write ${r"#{paramName}"}. With this directive you can write more simple:
  *
- * <blockquote><pre>
+ * <blockquote>
+ * 
+ * <pre>
  *     &lt;@p name="paramName"/&gt;
- * </pre></blockquote>
+ * </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:
+ * 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>
+ * <blockquote>
+ * 
+ * <pre>
  *     &lt;#list ids as id&gt;
  *       &lt;@p value=id/&gt;
  *       &lt;#if id_has_next&gt;,&lt;/#if&gt;
  *     &lt;/#list&gt;
- * </pre></blockquote>
+ * </pre>
+ * 
+ * </blockquote>
  *
  * <p>
  * will be translated into
  * </p>
  *
- * <blockquote><pre>
+ * <blockquote>
+ * 
+ * <pre>
  *     #{_p0},#{_p1},#{_p2}
- * </pre></blockquote>
+ * </pre>
+ * 
+ * </blockquote>
  *
  * <p>
  * And MyBatis engine will convert it to `?`-params finally.

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2017 the original author or authors.
+ *    Copyright 2015-2018 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.
@@ -26,8 +26,8 @@
 import java.util.HashMap;
 
 /**
- * Important: if you are using some object that already has property "p", then
- * MyBatisParamDirective will be unavailable from script.
+ * Important: if you are using some object that already has property "p", then MyBatisParamDirective will be unavailable
+ * from script.
  *
  * @author elwood
  */
@@ -42,9 +42,8 @@ public ParamObjectAdapter(Object paramObject, ArrayList generatedParams) {
   }
 
   /**
-   * Puts the additional parameter into adapter, it will be available if no
-   * existing property with same key exists. For example, it is suitable to add
-   * custom objects and directives into dataContext.
+   * Puts the additional parameter into adapter, it will be available if no existing property with same key exists. For
+   * example, it is suitable to add custom objects and directives into dataContext.
    */
   public void putAdditionalParam(String key, TemplateModel value) {
     if (additionalParams == null) {

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2017 the original author or authors.
+ *    Copyright 2015-2018 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.
@@ -42,28 +42,27 @@ public interface NameMapper {
   Name findName(@Param("name") String name);
 
   /**
-   * If any whitespace found inside @Select text, it is interpreted as inline script, not template name.
-   * It is convenient to avoid creating templates when script is really small.
+   * If any whitespace found inside @Select text, it is interpreted as inline script, not template name. It is
+   * convenient to avoid creating templates when script is really small.
    */
   @Lang(FreeMarkerLanguageDriver.class)
   @Select("select * from names where id in (${ids?join(',')})")
   List<Name> findNamesByIds(@Param("ids") List<Integer> ids);
 
   /**
-   * There are no @Param annotation on argument. This means NameParam instance
-   * will be passed into driver as is, not as Map entry. So, we need to support this case.
-   * Because in driver we need to add some another properties into template model,
-   * and NameParam is not Map, we are need to wrap passed parameter object into
+   * There are no @Param annotation on argument. This means NameParam instance will be passed into driver as is, not as
+   * Map entry. So, we need to support this case. Because in driver we need to add some another properties into template
+   * model, and NameParam is not Map, we are need to wrap passed parameter object into
    * {@link org.mybatis.scripting.freemarker.ParamObjectAdapter} before processing template.
    */
   @Lang(FreeMarkerLanguageDriver.class)
   @Select("select * from names where id = <@p name='id'/> and id = ${id}")
   Name find(NameParam nameParam);
 
   /**
-   * This query is to demonstrate MyBatis odd behaviour when using String as parameter
-   * and can use properties that not exist. Both props will be use provided `name` parameter value.
-   * Goal is to write FreeMarker lang plugin to support this behaviour too (although it is confusing one).
+   * This query is to demonstrate MyBatis odd behaviour when using String as parameter and can use properties that not
+   * exist. Both props will be use provided `name` parameter value. Goal is to write FreeMarker lang plugin to support
+   * this behaviour too (although it is confusing one).
    */
   @Select("select * from names" + " where firstName = #{noSuchPropertyOnString}"
       + " or firstName = #{oneMoreUnexistingProperty}")

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2017 the original author or authors.
+ *    Copyright 2015-2018 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.
@@ -22,8 +22,7 @@
 import java.util.List;
 
 /**
- * This mapper demonstrates the usage of auto-generating prepared statement
- * parameters instead of usual inline strategy.
+ * This mapper demonstrates the usage of auto-generating prepared statement parameters instead of usual inline strategy.
  *
  * @author elwood
  */
@@ -33,9 +32,8 @@ public interface PreparedParamsMapper {
   List<Name> findByNames(@Param("ids") List<String> ids);
 
   /**
-   * This is doesn't work - because params objects are unsupported when using
-   * auto-generated prepared parameters (it is impossible to add parameters
-   * to MyBatis engine). This call will throw exception.
+   * This is doesn't work - because params objects are unsupported when using auto-generated prepared parameters (it is
+   * impossible to add parameters to MyBatis engine). This call will throw exception.
    */
   @Lang(FreeMarkerLanguageDriver.class)
   @Select("prepared.ftl")