Package org.jdbi.v3.core.statement

Class Binding

  • Direct Known Subclasses:
    PreparedBinding
    public class Binding
extends java.lang.Object
    Represents the arguments bound to a particular statement.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addNamed​(java.lang.String name, java.lang.Object argument)
      Bind a named parameter for the given name.
      void addNamed​(java.lang.String name, java.lang.Object argument, QualifiedType<?> type)
      Bind a named parameter for the given name.
      void addNamed​(java.lang.String name, Argument argument)
      Bind a named parameter for the given name.
      void addNamedArgumentFinder​(NamedArgumentFinder args)
      Bind a named argument finder.
      void addPositional​(int position, java.lang.Object argument)
      Bind a positional parameter at the given index (0-based).
      void addPositional​(int position, java.lang.Object argument, QualifiedType<?> type)
      Bind a positional parameter at the given index (0-based).
      void addPositional​(int position, Argument argument)
      Bind a positional parameter at the given index (0-based).
      void clear()
      Remove all bindings from this Binding.
      java.util.Optional<Argument> findForName​(java.lang.String name, StatementContext ctx2)
      Deprecated.
      don't inspect a Binding: keep your own state!
      java.util.Optional<Argument> findForPosition​(int position)
      Deprecated.
      don't inspect a Binding: keep your own state!
      java.util.Collection<java.lang.String> getNames()
      Deprecated.
      this is expensive to compute, and it's bad practice to inspect a Binding: keep track of your own state!
      boolean isEmpty()
      Returns whether any bindings exist.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • positionals

        protected final java.util.Map<java.lang.Integer,​java.lang.Object> positionals

      • named

        protected final java.util.Map<java.lang.String,​java.lang.Object> named

    • Method Detail

      • addPositional

        public void addPositional​(int position,
                          Argument argument)
        Bind a positional parameter at the given index (0-based).
        Parameters:
        position - binding position
        argument - the argument to bind

      • addNamed

        public void addNamed​(java.lang.String name,
                     Argument argument)
        Bind a named parameter for the given name.
        Parameters:
        name - bound argument name
        argument - the argument to bind

      • addPositional

        public void addPositional​(int position,
                          java.lang.Object argument)
        Bind a positional parameter at the given index (0-based).
        Parameters:
        position - binding position
        argument - the argument to bind

      • addNamed

        public void addNamed​(java.lang.String name,
                     java.lang.Object argument)
        Bind a named parameter for the given name.
        Parameters:
        name - bound argument name
        argument - the argument to bind

      • addPositional

        public void addPositional​(int position,
                          java.lang.Object argument,
                          QualifiedType<?> type)
        Bind a positional parameter at the given index (0-based).
        Parameters:
        position - binding position
        argument - the argument to bind

      • addNamed

        public void addNamed​(java.lang.String name,
                     java.lang.Object argument,
                     QualifiedType<?> type)
        Bind a named parameter for the given name.
        Parameters:
        name - bound argument name
        argument - the argument to bind

      • addNamedArgumentFinder

        public void addNamedArgumentFinder​(NamedArgumentFinder args)
        Bind a named argument finder.
        Parameters:
        args - the argument finder to bind

      • findForName

        @Deprecated
public java.util.Optional<Argument> findForName​(java.lang.String name,
                                                StatementContext ctx2)
        Deprecated.
        don't inspect a Binding: keep your own state!
        Look up an argument by name.
        Parameters:
        name - the key to lookup the value of
        ctx2 - the statement context
        Returns:
        the bound Argument

      • getNames

        @Deprecated
public java.util.Collection<java.lang.String> getNames()
        Deprecated.
        this is expensive to compute, and it's bad practice to inspect a Binding: keep track of your own state!
        Returns:
        the set of known binding names

      • findForPosition

        @Deprecated
public java.util.Optional<Argument> findForPosition​(int position)
        Deprecated.
        don't inspect a Binding: keep your own state!
        Look up an argument by position.
        Parameters:
        position - starts at 0, not 1
        Returns:
        argument bound to that position

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • clear

        public void clear()
        Remove all bindings from this Binding.

      • isEmpty

        public boolean isEmpty()
        Returns whether any bindings exist.
        Returns:
        True if there are no bindings.