Package org.apache.ibatis.annotations

Annotation Type Arg

  • @Documented
@Retention(RUNTIME)
@Target(METHOD)
@Repeatable(ConstructorArgs.class)
public @interface Arg
    The annotation that specify a mapping definition for the constructor argument.
    Author:
    Clinton Begin
    See Also:
    ConstructorArgs

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String column
      Return the column name(or column label) to map to this argument.
      java.lang.String columnPrefix
      Returns the column prefix that use when applying resultMap().
      boolean id
      Returns whether id column or not.
      java.lang.Class<?> javaType
      Return the java type for this argument.
      JdbcType jdbcType
      Return the jdbc type for column that map to this argument.
      java.lang.String name
      Returns the parameter name for applying this mapping.
      java.lang.String resultMap
      Returns the result map id for mapping to a object that map to this argument.
      java.lang.String select
      Return the statement id for retrieving a object that map to this argument.
      java.lang.Class<? extends TypeHandler> typeHandler
      Returns the TypeHandler type for retrieving a column value from result set.

    • Element Detail

      • id

        boolean id
        Returns whether id column or not.
        Returns:
        true if id column; false if otherwise
        Default:
        false

      • column

        java.lang.String column
        Return the column name(or column label) to map to this argument.
        Returns:
        the column name(or column label)
        Default:
        ""

      • javaType

        java.lang.Class<?> javaType
        Return the java type for this argument.
        Returns:
        the java type
        Default:
        void.class

      • jdbcType

        JdbcType jdbcType
        Return the jdbc type for column that map to this argument.
        Returns:
        the jdbc type
        Default:
        org.apache.ibatis.type.JdbcType.UNDEFINED

      • typeHandler

        java.lang.Class<? extends TypeHandler> typeHandler
        Returns the TypeHandler type for retrieving a column value from result set.
        Returns:
        the TypeHandler type
        Default:
        org.apache.ibatis.type.UnknownTypeHandler.class

      • select

        java.lang.String select
        Return the statement id for retrieving a object that map to this argument.
        Returns:
        the statement id
        Default:
        ""

      • resultMap

        java.lang.String resultMap
        Returns the result map id for mapping to a object that map to this argument.
        Returns:
        the result map id
        Default:
        ""

      • name

        java.lang.String name
        Returns the parameter name for applying this mapping.
        Returns:
        the parameter name
        Since:
        3.4.3
        Default:
        ""

      • columnPrefix

        java.lang.String columnPrefix
        Returns the column prefix that use when applying resultMap().
        Returns:
        the column prefix
        Since:
        3.5.0
        Default:
        ""