Package com.googlecode.objectify.cmd

Interface DeleteIds

  • All Known Subinterfaces:
    DeleteType
    public interface DeleteIds

    Terminator methods for a delete-by-key command chain which constructs the key implicitly from type, id, and (optionally) parent.

    Deletes do NOT cascade; you must delete each individual entity in an object graph.

    All command objects are immutable.

    Author:
    Jeff Schnitzer

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Result<Void> id​(long id)
      Specify the numeric id of an entity and start asynchronous deletion.
      Result<Void> id​(String id)
      Specify the String id of an entity and start asynchronous deletion.
      Result<Void> ids​(long... ids)
      Specify the numeric ids of multiple entities and start asynchronous deletion.
      <S> Result<Void> ids​(Iterable<S> ids)
      Specify the ids of multiple entities and start asynchronous deletion.
      Result<Void> ids​(String... ids)
      Specify the String ids of multiple entities and start asynchronous deletion.

    • Method Detail

      • id

        Result<Void> id​(long id)

        Specify the numeric id of an entity and start asynchronous deletion.

        Parameters:
        id - - the id of the entity to delete. Note that numeric ids and String ids are not equivalent; 123 and "123" are different ids.
        Returns:
        an asynchronous Result of the deletion. Force synchronous delete by calling Result.now().

      • id

        Result<Void> id​(String id)

        Specify the String id of an entity and start asynchronous deletion.

        Parameters:
        id - - the id of the entity to delete. Note that numeric ids and String ids are not equivalent; 123 and "123" are different ids.
        Returns:
        an asynchronous Result of the deletion. Force synchronous delete by calling Result.now().

      • ids

        Result<Void> ids​(long... ids)

        Specify the numeric ids of multiple entities and start asynchronous deletion.

        Parameters:
        ids - - the ids of the entity to delete. Note that numeric ids and String ids are not equivalent; 123 and "123" are different ids.
        Returns:
        an asynchronous Result of the deletion. Force synchronous delete by calling Result.now().

      • ids

        Result<Void> ids​(String... ids)

        Specify the String ids of multiple entities and start asynchronous deletion.

        Parameters:
        ids - - the ids of the entity to delete. Note that numeric ids and String ids are not equivalent; 123 and "123" are different ids.
        Returns:
        an asynchronous Result of the deletion. Force synchronous delete by calling Result.now().

      • ids

        <S> Result<Void> ids​(Iterable<S> ids)

        Specify the ids of multiple entities and start asynchronous deletion.

        Parameters:
        ids - - the ids of the entities to delete. The Iterator must provide Long or String. Note that numeric ids and String ids are not equivalent; 123 and "123" are different ids.
        Returns:
        an asynchronous Result of the deletion. Force synchronous delete by calling Result.now().