Package com.mongodb.client.model

Enum ValidationAction

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ValidationAction>
    public enum ValidationAction
extends java.lang.Enum<ValidationAction>
    Determines whether to error on invalid documents or just warn about the violations but allow invalid documents.
    Since:
    3.2

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ERROR
      Documents must pass validation before the write occurs.
      WARN
      Documents do not have to pass validation.

    • Method Summary

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

      • ERROR

        public static final ValidationAction ERROR
        Documents must pass validation before the write occurs. Otherwise, the write operation fails.

      • WARN

        public static final ValidationAction WARN
        Documents do not have to pass validation. If the document fails validation, the write operation logs the validation failure to the mongod logs.

    • Method Detail

      • values

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

      • valueOf

        public static ValidationAction 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 validation level that the MongoDB server understands

      • fromString

        public static ValidationAction fromString​(java.lang.String validationAction)
        Returns the validationAction from the string representation of a validation action.
        Parameters:
        validationAction - the string representation of the validation action.
        Returns:
        the validation action