Package org.jdbi.v3.sqlobject.customizer

Interface SqlStatementCustomizerFactory

All Known Implementing Classes:

AllowUnusedBindingsFactory, BindBeanFactory, BindBeanListFactory, BindFactory, BindFieldsFactory, BindJpaFactory, BindListFactory, BindMapFactory, BindMethodsFactory, BindMethodsListFactory, BindPojoFactory, DefineFactory, DefineListFactory, DefineNamedBindingsFactory, FetchSizeFactory, MapToFactory, MaxRowsFactory, OutParameterFactory, OutParameterListFactory, QueryTimeOutFactory, TimestampedFactory

public interface SqlStatementCustomizerFactory

Interface used in conjunction with SqlStatementCustomizingAnnotation to generate SqlStatementCustomizer instances.

Method Summary

Modifier and Type	Method	Description
default SqlStatementCustomizer	createForMethod(java.lang.annotation.Annotation annotation, java.lang.Class<?> sqlObjectType, java.lang.reflect.Method method)	Used to create customizers for annotations on methods.
default SqlStatementParameterCustomizer	createForParameter(java.lang.annotation.Annotation annotation, java.lang.Class<?> sqlObjectType, java.lang.reflect.Method method, java.lang.reflect.Parameter param, int index, java.lang.reflect.Type paramType)	Used to create customizers for annotations on parameters
default SqlStatementCustomizer	createForType(java.lang.annotation.Annotation annotation, java.lang.Class<?> sqlObjectType)	Used to create customizers for annotations on sql object interfaces

Method Detail

createForType

default SqlStatementCustomizer createForType(java.lang.annotation.Annotation annotation,
                                             java.lang.Class<?> sqlObjectType)

Used to create customizers for annotations on sql object interfaces

Parameters:

annotation - the annotation which lead to the method being called

sqlObjectType - sql object class (interface)

Returns:

the customizer which will be applied to the generated statement

createForMethod

default SqlStatementCustomizer createForMethod(java.lang.annotation.Annotation annotation,
                                               java.lang.Class<?> sqlObjectType,
                                               java.lang.reflect.Method method)

Used to create customizers for annotations on methods.

Parameters:

annotation - the annotation which lead to the method being called

sqlObjectType - sql object class (interface)

method - the method which was annotated

Returns:

the customizer which will be applied to the generated statement

createForParameter

default SqlStatementParameterCustomizer createForParameter(java.lang.annotation.Annotation annotation,
                                                           java.lang.Class<?> sqlObjectType,
                                                           java.lang.reflect.Method method,
                                                           java.lang.reflect.Parameter param,
                                                           int index,
                                                           java.lang.reflect.Type paramType)

Used to create customizers for annotations on parameters

Parameters:

annotation - the annotation which lead to the method being called

sqlObjectType - sql object class (interface)

method - the method which was annotated

param - the parameter which was annotated

index - the method parameter index

paramType - the type of the parameter

Returns:

the customizer which will be applied to the generated statement