From d176ffd81bf034797309137cf818af7162cc5f75 Mon Sep 17 00:00:00 2001 From: Kazuki Shimizu Date: Sun, 5 May 2019 03:17:19 +0900 Subject: [PATCH] Rename Driver to VelocityLanguageDriver Fixes gh-65 --- .../mybatis/scripting/velocity/Driver.java | 51 ++---------- .../velocity/VelocityLanguageDriver.java | 81 +++++++++++++++++++ src/site/xdoc/index.xml | 4 +- .../scripting/velocity/use/MapperConfig.xml | 4 +- 4 files changed, 90 insertions(+), 50 deletions(-) create mode 100644 src/main/java/org/mybatis/scripting/velocity/VelocityLanguageDriver.java diff --git a/src/main/java/org/mybatis/scripting/velocity/Driver.java b/src/main/java/org/mybatis/scripting/velocity/Driver.java index 2490bdf..8737072 100644 --- a/src/main/java/org/mybatis/scripting/velocity/Driver.java +++ b/src/main/java/org/mybatis/scripting/velocity/Driver.java @@ -15,50 +15,9 @@ */ package org.mybatis.scripting.velocity; -import org.apache.ibatis.executor.parameter.ParameterHandler; -import org.apache.ibatis.mapping.BoundSql; -import org.apache.ibatis.mapping.MappedStatement; -import org.apache.ibatis.mapping.SqlSource; -import org.apache.ibatis.parsing.XNode; -import org.apache.ibatis.scripting.LanguageDriver; -import org.apache.ibatis.scripting.defaults.DefaultParameterHandler; -import org.apache.ibatis.session.Configuration; - -public class Driver implements LanguageDriver { - - /** - * Default constructor. - */ - public Driver() { - this(VelocityLanguageDriverConfig.newInstance()); - } - - /** - * Constructor. - * - * @param driverConfig - * a language driver configuration - * @since 2.1.0 - */ - public Driver(VelocityLanguageDriverConfig driverConfig) { - VelocityFacade.initialize(driverConfig); - } - - @Override - public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, - BoundSql boundSql) { - return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql); - } - - @Override - public SqlSource createSqlSource(Configuration configuration, XNode script, Class parameterTypeClass) { - return new SQLScriptSource(configuration, script.getNode().getTextContent(), - parameterTypeClass == null ? Object.class : parameterTypeClass); - } - - @Override - public SqlSource createSqlSource(Configuration configuration, String script, Class parameterTypeClass) { - return new SQLScriptSource(configuration, script, parameterTypeClass == null ? Object.class : parameterTypeClass); - } - +/** + * @deprecated Since 2.1.0, recommend to use the {@link VelocityLanguageDriver}. + */ +@Deprecated +public class Driver extends VelocityLanguageDriver { } diff --git a/src/main/java/org/mybatis/scripting/velocity/VelocityLanguageDriver.java b/src/main/java/org/mybatis/scripting/velocity/VelocityLanguageDriver.java new file mode 100644 index 0000000..0d6de55 --- /dev/null +++ b/src/main/java/org/mybatis/scripting/velocity/VelocityLanguageDriver.java @@ -0,0 +1,81 @@ +/** + * Copyright 2012-2019 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.mybatis.scripting.velocity; + +import org.apache.ibatis.executor.parameter.ParameterHandler; +import org.apache.ibatis.mapping.BoundSql; +import org.apache.ibatis.mapping.MappedStatement; +import org.apache.ibatis.mapping.SqlSource; +import org.apache.ibatis.parsing.XNode; +import org.apache.ibatis.scripting.LanguageDriver; +import org.apache.ibatis.scripting.defaults.DefaultParameterHandler; +import org.apache.ibatis.session.Configuration; + +/** + * The {@link LanguageDriver} using Velocity. + *

+ * This class rename from {@code Driver}. + *

+ * + * @since 2.1.0 + * @author Kazuki Shimizu + */ +public class VelocityLanguageDriver implements LanguageDriver { + + /** + * Default constructor. + */ + public VelocityLanguageDriver() { + this(VelocityLanguageDriverConfig.newInstance()); + } + + /** + * Constructor. + * + * @param driverConfig + * a language driver configuration + */ + public VelocityLanguageDriver(VelocityLanguageDriverConfig driverConfig) { + VelocityFacade.initialize(driverConfig); + } + + /** + * {@inheritDoc} + */ + @Override + public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, + BoundSql boundSql) { + return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql); + } + + /** + * {@inheritDoc} + */ + @Override + public SqlSource createSqlSource(Configuration configuration, XNode script, Class parameterTypeClass) { + return new SQLScriptSource(configuration, script.getNode().getTextContent(), + parameterTypeClass == null ? Object.class : parameterTypeClass); + } + + /** + * {@inheritDoc} + */ + @Override + public SqlSource createSqlSource(Configuration configuration, String script, Class parameterTypeClass) { + return new SQLScriptSource(configuration, script, parameterTypeClass == null ? Object.class : parameterTypeClass); + } + +} diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index d6793cb..b700396 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -1,7 +1,7 @@