org.seasar.doma.jdbc

Interface Commenter

All Known Implementing Classes:

CallerCommenter

public interface Commenter

A commenter for SQL strings.

The comment is added to the SQL string that may be built from a SQL template or may be auto generated.

The implementation must not add anything except a comment.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	comment(java.lang.String sql, CommentContext context) Adds the comment to the SQL string.

Method Detail

comment

default java.lang.String comment(java.lang.String sql,
                                 CommentContext context)

Adds the comment to the SQL string.

Parameters:

sql - the SQL string

context - the context

Returns:

the SQL that the comment is added