Improve Javadocs

Author: jeffgbutler

src/main/java/org/mybatis/dynamic/sql/render/RenderingStrategy.java

@@ -36,14 +36,38 @@
 public abstract class RenderingStrategy {
     public static final String DEFAULT_PARAMETER_PREFIX = "parameters"; //$NON-NLS-1$
 
+    /**
+     * Return a unique key that can be used to place a parameter value in the parameter map
+     *
+     * @param sequence a sequence for calculating a unique value
+     * @return a key used to place the parameter value in the parameter map
+     */
     public String formatParameterMapKey(AtomicInteger sequence) {
         return "p" + sequence.getAndIncrement(); //$NON-NLS-1$
     }
 
+    /**
+     * Return a parameter map key intended as a parameter for a limit or fetch first query.
+     *
+     * <p>By default, this parameter is treated the same as any other. This method is a hook to support
+     * MyBatis Spring Batch.
+     *
+     * @param sequence a sequence for calculating a unique value
+     * @return a key used to place the parameter value in the parameter map
+     */
     public String formatParameterMapKeyForLimit(AtomicInteger sequence) {
         return formatParameterMapKey(sequence);
     }
 
+    /**
+     * Return a parameter map key intended as a parameter for a query offset.
+     *
+     * <p>By default, this parameter is treated the same as any other. This method is a hook to support
+     * MyBatis Spring Batch.
+     *
+     * @param sequence a sequence for calculating a unique value
+     * @return a key used to place the parameter value in the parameter map
+     */
     public String formatParameterMapKeyForOffset(AtomicInteger sequence) {
         return formatParameterMapKey(sequence);
     }
@@ -86,6 +110,19 @@ public String formatParameterMapKeyForOffset(AtomicInteger sequence) {
      */
     public abstract String getFormattedJdbcPlaceholder(String prefix, String parameterName);
 
+    /**
+     * This method generates a binding for a parameter to a placeholder in a generated SQL statement.
+     *
+     * <p>This method is used to generate bindings for limit, offset, and fetch first parameters. By default, these
+     * parameters are treated the same as any other. This method supports MyBatis Spring Batch integration where the
+     * parameter keys have predefined values and need special handling.
+     *
+     * @param prefix parameter prefix used for locating the parameters in a SQL provider object. Typically, will be
+     *               {@link RenderingStrategy#DEFAULT_PARAMETER_PREFIX}. This is ignored for Spring.
+     * @param parameterName name of the parameter. Typically generated by calling
+     *     {@link RenderingStrategy#formatParameterMapKey(AtomicInteger)}
+     * @return the generated binding
+     */
     public String getFormattedJdbcPlaceholderForLimitOrOffset(String prefix, String parameterName) {
         return getFormattedJdbcPlaceholder(prefix, parameterName);
     }