Package com.mongodb.client.model.changestream

Enum FullDocument

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FullDocument>
    public enum FullDocument
extends java.lang.Enum<FullDocument>
    Change Stream fullDocument configuration.

    Determines what to return for update operations when using a Change Stream. Defaults to DEFAULT. When set to UPDATE_LOOKUP, the change stream for partial updates will include both a delta describing the changes to the document as well as a copy of the entire document that was changed from some time after the change occurred.

    Since:
    3.6

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static FullDocument fromString​(java.lang.String changeStreamFullDocument)
      Returns the ChangeStreamFullDocument from the string value.
      java.lang.String getValue()  
      static FullDocument valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FullDocument[] 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

      • DEFAULT

        public static final FullDocument DEFAULT
        Default

        Returns the servers default value in the fullDocument field.

      • UPDATE_LOOKUP

        public static final FullDocument UPDATE_LOOKUP
        Lookup

        The change stream for partial updates will include both a delta describing the changes to the document as well as a copy of the entire document that was changed from some time after the change occurred.

    • Method Detail

      • values

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

      • valueOf

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

      • getValue

        public java.lang.String getValue()
        Returns:
        the String representation of the collation case first value

      • fromString

        public static FullDocument fromString​(java.lang.String changeStreamFullDocument)
        Returns the ChangeStreamFullDocument from the string value.
        Parameters:
        changeStreamFullDocument - the string value.
        Returns:
        the read concern