Merge pull request #388 from domaframework/comment-context

Enhance the CommentContext class to accept a message

Author: nakamura-to

doma-core/src/main/java/org/seasar/doma/jdbc/CommentContext.java

@@ -16,15 +16,19 @@ public class CommentContext {
 
   protected final Optional<Method> method;
 
+  protected final Optional<String> message;
+
   /**
    * Creates an instance.
    *
    * @param className the class name that executes the SQL
    * @param methodName the method name that executes the SQL
    * @param config the configuration
    * @param method the DAO method
+   * @param message the message
    */
-  public CommentContext(String className, String methodName, Config config, Method method) {
+  public CommentContext(
+      String className, String methodName, Config config, Method method, String message) {
     if (className == null) {
       throw new DomaNullPointerException("className");
     }
@@ -38,6 +42,7 @@ public CommentContext(String className, String methodName, Config config, Method
     this.methodName = methodName;
     this.config = config;
     this.method = Optional.ofNullable(method);
+    this.message = Optional.ofNullable(message);
   }
 
   /**
@@ -76,4 +81,13 @@ public Config getConfig() {
   public Optional<Method> getMethod() {
     return method;
   }
+
+  /**
+   * Returns the message or {@link Optional#empty()}.
+   *
+   * @return the message or {@link Optional#empty()} if it does not exit
+   */
+  public Optional<String> getMessage() {
+    return message;
+  }
 }

doma-core/src/main/java/org/seasar/doma/jdbc/query/AbstractQuery.java

@@ -70,7 +70,7 @@ public void setQueryTimeout(int queryTimeout) {
   @Override
   public void prepare() {
     assertNotNull(callerClassName, callerMethodName, config);
-    commentContext = new CommentContext(callerClassName, callerMethodName, config, method);
+    commentContext = new CommentContext(callerClassName, callerMethodName, config, method, null);
   }
 
   @Override

doma-core/src/test/java/org/seasar/doma/jdbc/CallerCommenterTest.java

@@ -11,7 +11,7 @@ public class CallerCommenterTest {
 
   @Test
   public void testComment() throws Exception {
-    CommentContext context = new CommentContext("class", "method", new MockConfig(), null);
+    CommentContext context = new CommentContext("class", "method", new MockConfig(), null, null);
     String actual = commenter.comment("select * from emp", context);
     assertEquals("/** class.method */" + System.lineSeparator() + "select * from emp", actual);
   }

doma-core/src/test/java/org/seasar/doma/jdbc/CommentContextTest.java

@@ -0,0 +1,22 @@
+package org.seasar.doma.jdbc;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+
+import org.junit.jupiter.api.Test;
+import org.seasar.doma.internal.jdbc.mock.MockConfig;
+
+class CommentContextTest {
+
+  @Test
+  void getMessage() {
+    CommentContext context = new CommentContext("class", "method", new MockConfig(), null, "hello");
+    assertEquals("hello", context.getMessage().get());
+  }
+
+  @Test
+  void getMessage_empty() {
+    CommentContext context = new CommentContext("class", "method", new MockConfig(), null, null);
+    assertFalse(context.getMessage().isPresent());
+  }
+}