Package org.mybatis.dynamic.sql

Class BoundValue<T>

java.lang.Object
org.mybatis.dynamic.sql.BoundValue<T>
Type Parameters:
T - the column type
All Implemented Interfaces:
BasicColumn, BindableColumn<T>
public class BoundValue<T> extends Object implements BindableColumn<T>
BoundValues are added to rendered SQL as a parameter marker only.

BoundValues are most useful in the context of functions. For example, a column value could be incremented with an update statement like this: UpdateStatementProvider updateStatement = update(person) .set(age).equalTo(add(age, value(1))) .where(id, isEqualTo(5)) .build() .render(RenderingStrategies.MYBATIS3);

Since:
1.5.1

  • Method Details

    • render

      public FragmentAndParameters render(RenderingContext renderingContext)
      Description copied from interface: BasicColumn
      Returns a rendering of the column. The rendered fragment should include the table alias based on the TableAliasCalculator in the RenderingContext. The fragment could contain prepared statement parameter markers and associated parameter values if desired.
      Specified by:
      render in interface BasicColumn
      Parameters:
      renderingContext - the rendering context (strategy, sequence, etc.)
      Returns:
      a rendered SQL fragment and, optionally, parameters associated with the fragment

    • alias

      public Optional<String> alias()
      Description copied from interface: BasicColumn
      Returns the columns alias if one has been specified.
      Specified by:
      alias in interface BasicColumn
      Returns:
      the column alias

    • as

      public BoundValue<T> as(String alias)
      Description copied from interface: BindableColumn
      Override the base method definition to make it more specific to this interface.
      Specified by:
      as in interface BasicColumn
      Specified by:
      as in interface BindableColumn<T>
      Parameters:
      alias - the column alias to set
      Returns:
      new instance with alias set

    • of

      public static <T> BoundValue<T> of(T value)