Module org.seasar.doma.core

Package org.seasar.doma.jdbc

Class CommentContext

java.lang.Object

org.seasar.doma.jdbc.CommentContext

public class CommentContext
extends Object

A context for a comment.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	className
protected final Config	config
protected final Optional<String>	message
protected final Optional<Method>	method
protected final String	methodName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getClassName()	Returns the class name that executes the SQL.
Config	getConfig()	Returns the configuration.
Optional<String>	getMessage()	Returns the message or Optional.empty().
Optional<Method>	getMethod()	Returns the DAO method or Optional.empty() if the SQL is built by the builder classes such as SelectBuilder.
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 Details

className

protected final String className

methodName

protected final String methodName

config

protected final Config config

method

protected final Optional<Method> method

message

protected final Optional<String> message

Constructor Details

CommentContext

public CommentContext(String className,
 String methodName,
 Config config,
 Method method,
 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 Details

getClassName

public String getClassName()

Returns the class name that executes the SQL.

Returns:

the class name

getMethodName

public 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 Optional<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 Optional<String> getMessage()

Returns the message or Optional.empty().

Returns:

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