Enum WriteMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<WriteMode>

    public enum WriteMode
    extends java.lang.Enum<WriteMode>
    Defines allowed operations.
    Since:
    5.3
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      INSERT_ONLY
      Items will be inserted to MongoDB; in case of ID clash, error will be thrown.
      REPLACE
      Performs replace.
      UPDATE_ONLY
      Performs update.
      UPSERT
      Performs update.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static WriteMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static WriteMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • INSERT_ONLY

        public static final WriteMode INSERT_ONLY
        Items will be inserted to MongoDB; in case of ID clash, error will be thrown.
      • UPDATE_ONLY

        public static final WriteMode UPDATE_ONLY
        Performs update. Entity with the given _id must already exist, otherwise an error will be thrown.
      • UPSERT

        public static final WriteMode UPSERT
        Performs update. If the entity with the given _id does not exist, it will be created.
      • REPLACE

        public static final WriteMode REPLACE
        Performs replace. If the entity with the given _id does not exist, it will be created (if it was not overridden by the user).

        Replace is different from UPSERT in handling of missing fields. Replace will set them to null, while upsert won't affect such fields in the entity.

    • Method Detail

      • values

        public static WriteMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (WriteMode c : WriteMode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static WriteMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null