Class SqlObjectClasspathSqlLocator

java.lang.Object

org.jdbi.v3.sqlobject.locator.SqlObjectClasspathSqlLocator

All Implemented Interfaces:

SqlLocator

public class SqlObjectClasspathSqlLocator
extends Object
implements SqlLocator

Locates SQL in .sql files on the classpath for use with SqlQuery. Given a class and method name, for example com.foo.Bar#query, load a classpath resource name like com/foo/Bar/query.sql and use it with the annotation. The contents are then parsed, cached, and returned for use by a statement.

See Also:

• ClasspathSqlLocator

Constructor Summary

Constructors

Constructor	Description
SqlObjectClasspathSqlLocator()	Creates a new SqlObjectClasspathSqlLocator.
SqlObjectClasspathSqlLocator(ClasspathSqlLocator locator)	Creates a new SqlObjectClasspathSqlLocator.

Method Summary

Modifier and Type	Method	Description
String	locate(Class<?> sqlObjectType, Method method, ConfigRegistry config)	Locates and returns the SQL for the given SQL Object type and method.

Methods inherited from class java.lang.Object

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

Constructor Details

SqlObjectClasspathSqlLocator

public SqlObjectClasspathSqlLocator()

Creates a new SqlObjectClasspathSqlLocator. Uses a ClasspathSqlLocator instance that strips comments off.

SqlObjectClasspathSqlLocator

public SqlObjectClasspathSqlLocator(ClasspathSqlLocator locator)

Creates a new SqlObjectClasspathSqlLocator.

Parameters:

locator - A ClasspathSqlLocator instance

Method Details

locate

public String locate(Class<?> sqlObjectType,
 Method method,
 ConfigRegistry config)

Description copied from interface: SqlLocator

Locates and returns the SQL for the given SQL Object type and method.

Specified by:

locate in interface SqlLocator

Parameters:

sqlObjectType - the SQL object type

method - the method

config - the config registry

Returns:

the SQL for the given method.