Annotation Type Delete


  • @Target(METHOD)
    @Retention(RUNTIME)
    public @interface Delete
    The delete annotation is used to indicate that a method will perform delete operation on the database.
    This annotation can be configured in two ways:
    • annotate the method without providing "where arguments"(deleteBy)to perform the delete operation by, which will result in deleting the the in the database based on the provided primaryKey. in this approach the method must be void/MyObject/int "methodName"(Connection, Object), where the return type determines if the method returns nothing(void), number of affected rows(int) , deleted object(MyObject).

    • annotate the method and provide the deleteBy value. In this case the method must be provided as the following void/int "methodName"(Connection, Object[]), where the first object in the array of objects is the object to be deleted and the rest is the values of the where arguments if the objects where not set then the database might throw a SQLException or the library will ignore the deleteBy values, it depends on whether the user overloads the method with a different configuration for Example:

      * @Delete(deleteBy = {"name"}) // deleteBy values ignored Movie delete(Connection connection, Movie move); *@Delete int delete(Connection connection, Object...whargs); // SQLException thrown

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String[] deleteBy  
    • Element Detail

      • deleteBy

        java.lang.String[] deleteBy
        Returns:
        the where arguments to delete the rows by
        Default:
        {}