domaframework · xterao · Jun 10, 2025 · Jun 10, 2025 · Jun 10, 2025 · Jun 10, 2025
diff --git a/README.md b/README.md
@@ -35,12 +35,15 @@ The plugin also provides quick fixes for DAO methods where the required SQL file
   ![quickfix.png](images/quickfix.png)
 - Checks for unused DAO method arguments.
   ![inspection.png](images/inspection.png)
+- Checks that the return type of DAO method matches the expected type based on its annotation.
+  ![returnTypeInspection.png](images/returnTypeInspection.png)
 - Checks for undefined bind variable names.
 - Checks the class name and package name for static property calls.
   ![inspectionPackageName.png](images/inspectionPackageName.png)
 - Optional types are recognized as their element type (e.g., a parameter of type `Optional<String>` is treated as type `String`).
 - For custom functions, checks for methods that are not defined in the configured ExpressionFunctions implementation class.
 
+
 ## Completion
 Code completion is available to assist you in coding within directives.
 

diff --git a/images/returnTypeInspection.png b/images/returnTypeInspection.png
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/common/psi/PsiDaoMethod.kt b/src/main/kotlin/org/domaframework/doma/intellij/common/psi/PsiDaoMethod.kt
@@ -61,7 +61,7 @@ class PsiDaoMethod(
         psiMethod.containingFile.virtualFile
             ?: psiMethod.containingFile.originalFile.virtualFile
     var daoType: DomaAnnotationType = DomaAnnotationType.Unknown
-    private var sqlFileOption: Boolean = false
+    var sqlFileOption: Boolean = false
 
     init {
         setDaoAnnotationType()
@@ -77,8 +77,7 @@ class PsiDaoMethod(
 
     private fun setSqlFileOption() {
         val useSqlFileOptionAnnotation = daoType.getPsiAnnotation(psiMethod) ?: return
-        val isSqlFile = daoType.getSqlFileVal(useSqlFileOptionAnnotation)
-        sqlFileOption = isSqlFile == true
+        sqlFileOption = daoType.getSqlFileVal(useSqlFileOptionAnnotation)
     }
 
     @OptIn(ExperimentalStdlibApi::class)

diff --git a/src/main/kotlin/org/domaframework/doma/intellij/common/util/ForDirectiveUtil.kt b/src/main/kotlin/org/domaframework/doma/intellij/common/util/ForDirectiveUtil.kt
@@ -34,10 +34,10 @@ import org.domaframework.doma.intellij.common.psi.PsiStaticElement
 import org.domaframework.doma.intellij.common.sql.PsiClassTypeUtil
 import org.domaframework.doma.intellij.common.sql.cleanString
 import org.domaframework.doma.intellij.common.sql.foritem.ForItem
-import org.domaframework.doma.intellij.common.sql.validator.result.ValidationCompleteResult
-import org.domaframework.doma.intellij.common.sql.validator.result.ValidationNotFoundTopTypeResult
-import org.domaframework.doma.intellij.common.sql.validator.result.ValidationPropertyResult
-import org.domaframework.doma.intellij.common.sql.validator.result.ValidationResult
+import org.domaframework.doma.intellij.common.validation.result.ValidationCompleteResult
+import org.domaframework.doma.intellij.common.validation.result.ValidationNotFoundTopTypeResult
+import org.domaframework.doma.intellij.common.validation.result.ValidationPropertyResult
+import org.domaframework.doma.intellij.common.validation.result.ValidationResult
 import org.domaframework.doma.intellij.extension.expr.accessElements
 import org.domaframework.doma.intellij.extension.psi.findParameter
 import org.domaframework.doma.intellij.extension.psi.findStaticField

diff --git a/...dator/result/ValidationClassPathResult.kt → ...ation/result/ValidationClassPathResult.kt b/...dator/result/ValidationClassPathResult.kt → ...ation/result/ValidationClassPathResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/...idator/result/ValidationCompleteResult.kt → ...dation/result/ValidationCompleteResult.kt b/...idator/result/ValidationCompleteResult.kt → ...dation/result/ValidationCompleteResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/...idator/result/ValidationDaoParamResult.kt → ...dation/result/ValidationDaoParamResult.kt b/...idator/result/ValidationDaoParamResult.kt → ...dation/result/ValidationDaoParamResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/...t/ValidationForDirectiveItemTypeResult.kt → ...t/ValidationForDirectiveItemTypeResult.kt b/...t/ValidationForDirectiveItemTypeResult.kt → ...t/ValidationForDirectiveItemTypeResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/...dationInvalidExpressionFunctionsResult.kt → ...dationInvalidExpressionFunctionsResult.kt b/...dationInvalidExpressionFunctionsResult.kt → ...dationInvalidExpressionFunctionsResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/...lt/ValidationInvalidFunctionCallResult.kt → ...lt/ValidationInvalidFunctionCallResult.kt b/...lt/ValidationInvalidFunctionCallResult.kt → ...lt/ValidationInvalidFunctionCallResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/...ValidationNotFoundStaticPropertyResult.kt → ...ValidationNotFoundStaticPropertyResult.kt b/...ValidationNotFoundStaticPropertyResult.kt → ...ValidationNotFoundStaticPropertyResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/...result/ValidationNotFoundTopTypeResult.kt → ...result/ValidationNotFoundTopTypeResult.kt b/...result/ValidationNotFoundTopTypeResult.kt → ...result/ValidationNotFoundTopTypeResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/...idator/result/ValidationPropertyResult.kt → ...dation/result/ValidationPropertyResult.kt b/...idator/result/ValidationPropertyResult.kt → ...dation/result/ValidationPropertyResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/.../sql/validator/result/ValidationResult.kt → ...mon/validation/result/ValidationResult.kt b/.../sql/validator/result/ValidationResult.kt → ...mon/validation/result/ValidationResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeHighlighting.HighlightDisplayLevel
 import com.intellij.codeInspection.ProblemHighlightType

diff --git a/...sult/ValidationUsedDaoMethodArgsResult.kt → ...eturnTypeForMultiInsertReturningResult.kt b/...sult/ValidationUsedDaoMethodArgsResult.kt → ...eturnTypeForMultiInsertReturningResult.kt
@@ -13,19 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange
 import com.intellij.psi.PsiElement
-import com.intellij.psi.PsiParameter
-import com.intellij.psi.impl.source.PsiParameterImpl
 import org.domaframework.doma.intellij.bundle.MessageBundle
 import org.domaframework.doma.intellij.common.psi.PsiParentClass
-import org.domaframework.doma.intellij.inspection.dao.visitor.DaoMethodVariableInspectionVisitor.DaoMethodVariableVisitorResult
 
-class ValidationUsedDaoMethodArgsResult(
-    private val daoMethodVariableResult: DaoMethodVariableVisitorResult,
+class ValidationReturnTypeForMultiInsertReturningResult(
+    private val paramClassName: String,
     override val identify: PsiElement?,
     override val shortName: String = "",
 ) : ValidationResult(identify, null, shortName) {
@@ -35,21 +32,15 @@ class ValidationUsedDaoMethodArgsResult(
         holder: ProblemsHolder,
         parent: PsiParentClass?,
     ) {
-        val param = identify as? PsiParameter ?: return
         val project = identify.project
-        val message =
-            if (daoMethodVariableResult.deplicateForItemElements.contains(identify)) {
-                MessageBundle.message("inspection.invalid.dao.duplicate")
-            } else {
-                MessageBundle.message(
-                    "inspection.invalid.dao.paramUse",
-                    param.name,
-                )
-            }
         holder.registerProblem(
-            (param.originalElement as PsiParameterImpl).nameIdentifier,
-            message,
+            identify,
+            MessageBundle.message(
+                "inspection.invalid.dao.multiInsert.returnType.returning",
+                paramClassName,
+            ),
             problemHighlightType(project, shortName),
+            highlightRange,
         )
     }
 }
diff --git a/...ramework/doma/intellij/common/validation/result/ValidationReturnTypeForReturningResult.kt b/...ramework/doma/intellij/common/validation/result/ValidationReturnTypeForReturningResult.kt
@@ -0,0 +1,46 @@
+/*
+ * Copyright Doma Tools 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
+ *
+ *     https://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.domaframework.doma.intellij.common.validation.result
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import org.domaframework.doma.intellij.bundle.MessageBundle
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+
+class ValidationReturnTypeForReturningResult(
+    private val paramClassName: String,
+    override val identify: PsiElement?,
+    override val shortName: String = "",
+) : ValidationResult(identify, null, shortName) {
+    override fun setHighlight(
+        highlightRange: TextRange,
+        identify: PsiElement,
+        holder: ProblemsHolder,
+        parent: PsiParentClass?,
+    ) {
+        val project = identify.project
+        holder.registerProblem(
+            identify,
+            MessageBundle.message(
+                "inspection.invalid.dao.update.returnType.returning",
+                paramClassName,
+            ),
+            problemHighlightType(project, shortName),
+            highlightRange,
+        )
+    }
+}
diff --git a/...maframework/doma/intellij/common/validation/result/ValidationReturnTypeImmutableResult.kt b/...maframework/doma/intellij/common/validation/result/ValidationReturnTypeImmutableResult.kt
@@ -0,0 +1,45 @@
+/*
+ * Copyright Doma Tools 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
+ *
+ *     https://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.domaframework.doma.intellij.common.validation.result
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import org.domaframework.doma.intellij.bundle.MessageBundle
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+
+class ValidationReturnTypeImmutableResult(
+    override val identify: PsiElement?,
+    override val shortName: String = "",
+    private val annotationName: String,
+    private val resultTypeName: String,
+    private val returnTypeName: String,
+) : ValidationResult(identify, null, shortName) {
+    override fun setHighlight(
+        highlightRange: TextRange,
+        identify: PsiElement,
+        holder: ProblemsHolder,
+        parent: PsiParentClass?,
+    ) {
+        val project = identify.project
+        holder.registerProblem(
+            identify,
+            MessageBundle.message("inspection.invalid.dao.returnType.immutable", annotationName, resultTypeName, returnTypeName),
+            problemHighlightType(project, shortName),
+            highlightRange,
+        )
+    }
+}
diff --git a/...in/org/domaframework/doma/intellij/common/validation/result/ValidationReturnTypeResult.kt b/...in/org/domaframework/doma/intellij/common/validation/result/ValidationReturnTypeResult.kt
@@ -0,0 +1,43 @@
+/*
+ * Copyright Doma Tools 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
+ *
+ *     https://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.domaframework.doma.intellij.common.validation.result
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import org.domaframework.doma.intellij.bundle.MessageBundle
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+
+class ValidationReturnTypeResult(
+    override val identify: PsiElement?,
+    override val shortName: String = "",
+    private val returnTypeName: String,
+) : ValidationResult(identify, null, shortName) {
+    override fun setHighlight(
+        highlightRange: TextRange,
+        identify: PsiElement,
+        holder: ProblemsHolder,
+        parent: PsiParentClass?,
+    ) {
+        val project = identify.project
+        holder.registerProblem(
+            identify,
+            MessageBundle.message("inspection.invalid.dao.returnType.psiTypes", returnTypeName),
+            problemHighlightType(project, shortName),
+            highlightRange,
+        )
+    }
+}
diff --git a/...or/result/ValidationSqlFileExistResult.kt → ...on/result/ValidationSqlFileExistResult.kt b/...or/result/ValidationSqlFileExistResult.kt → ...on/result/ValidationSqlFileExistResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

diff --git a/...omaframework/doma/intellij/common/validation/result/ValidationSqlProcessorReturnResult.kt b/...omaframework/doma/intellij/common/validation/result/ValidationSqlProcessorReturnResult.kt
@@ -0,0 +1,48 @@
+/*
+ * Copyright Doma Tools 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
+ *
+ *     https://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.domaframework.doma.intellij.common.validation.result
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import org.domaframework.doma.intellij.bundle.MessageBundle
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+
+class ValidationSqlProcessorReturnResult(
+    private val returnTypeName: String,
+    private val paramClassName: String,
+    override val identify: PsiElement?,
+    override val shortName: String = "",
+) : ValidationResult(identify, null, shortName) {
+    override fun setHighlight(
+        highlightRange: TextRange,
+        identify: PsiElement,
+        holder: ProblemsHolder,
+        parent: PsiParentClass?,
+    ) {
+        val project = identify.project
+        holder.registerProblem(
+            identify,
+            MessageBundle.message(
+                "inspection.invalid.dao.sqlProcessor.returnType.returning",
+                returnTypeName,
+                paramClassName,
+            ),
+            problemHighlightType(project, shortName),
+            highlightRange,
+        )
+    }
+}
diff --git a/...idator/result/ValidationTestDataResult.kt → ...dation/result/ValidationTestDataResult.kt b/...idator/result/ValidationTestDataResult.kt → ...dation/result/ValidationTestDataResult.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange