org.seasar.doma.jdbc

Class CommentContext

java.lang.Object

org.seasar.doma.jdbc.CommentContext

public class CommentContext
extends java.lang.Object

A context for a comment.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	className
protected Config	config
protected java.util.Optional<java.lang.String>	message
protected java.util.Optional<java.lang.reflect.Method>	method
protected java.lang.String	methodName

Constructor Summary

Constructors

Constructor and Description
CommentContext(java.lang.String className, java.lang.String methodName, Config config, java.lang.reflect.Method method, java.lang.String message) Creates an instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName() Returns the class name that executes the SQL.
Config	getConfig() Returns the configuration.
java.util.Optional<java.lang.String>	getMessage() Returns the message or Optional.empty().
java.util.Optional<java.lang.reflect.Method>	getMethod() Returns the DAO method or Optional.empty() if the SQL is built by the builder classes such as SelectBuilder.
java.lang.String	getMethodName() Returns the method name that executes the SQL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

className

protected final java.lang.String className

methodName

protected final java.lang.String methodName

config

protected final Config config

method

protected final java.util.Optional<java.lang.reflect.Method> method

message

protected final java.util.Optional<java.lang.String> message

Constructor Detail

CommentContext

public CommentContext(java.lang.String className,
                      java.lang.String methodName,
                      Config config,
                      java.lang.reflect.Method method,
                      java.lang.String message)

Creates an instance.

Parameters:

className - the class name that executes the SQL

methodName - the method name that executes the SQL

config - the configuration

method - the DAO method

message - the message

Method Detail

getClassName

public java.lang.String getClassName()

Returns the class name that executes the SQL.

Returns:

the class name

getMethodName

public java.lang.String getMethodName()

Returns the method name that executes the SQL.

Returns:

the method name

getConfig

public Config getConfig()

Returns the configuration.

Returns:

the configuration

getMethod

public java.util.Optional<java.lang.reflect.Method> getMethod()

Returns the DAO method or Optional.empty() if the SQL is built by the builder classes such as SelectBuilder.

Returns:

the DAO method or Optional.empty() if it does not exit

getMessage

public java.util.Optional<java.lang.String> getMessage()

Returns the message or Optional.empty().

Returns:

the message or Optional.empty() if it does not exit