Package com.mongodb.client.model

Enum ReturnDocument

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ReturnDocument>
    public enum ReturnDocument
extends java.lang.Enum<ReturnDocument>
    Indicates which document to return, the original document before change or the document after the change
    Since:
    3.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AFTER
      Indicates to return the document after the update, replacement, or insert occurred.
      BEFORE
      Indicates to return the document before the update, replacement, or insert occurred.

    • Method Summary

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

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • BEFORE

        public static final ReturnDocument BEFORE
        Indicates to return the document before the update, replacement, or insert occurred.

      • AFTER

        public static final ReturnDocument AFTER
        Indicates to return the document after the update, replacement, or insert occurred.

    • Method Detail

      • values

        public static ReturnDocument[] 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 (ReturnDocument c : ReturnDocument.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ReturnDocument 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