Enum UpdateMode

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

    @OpenApiAll
    public enum UpdateMode
    extends java.lang.Enum<UpdateMode>
    The update mode is used to determine when/if an element reference should be updated and/or checked by validation
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AUTOMATIC_CHECK
      Text containing references shall be checked by validation automatically for consistency
      AUTOMATIC_UPDATE
      Text containing references shall be updated if referred element changes
      MANUAL_CHECK
      Text containing references shall be checked for consistency when validation is run manually
      NO_UPDATE
      Text containing references shall not be updated if referred element changes
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static UpdateMode getUpdateMode​(java.lang.String name, UpdateMode defaultValue)  
      static UpdateMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static UpdateMode[] 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

      • AUTOMATIC_UPDATE

        public static final UpdateMode AUTOMATIC_UPDATE
        Text containing references shall be updated if referred element changes
      • AUTOMATIC_CHECK

        public static final UpdateMode AUTOMATIC_CHECK
        Text containing references shall be checked by validation automatically for consistency
      • MANUAL_CHECK

        public static final UpdateMode MANUAL_CHECK
        Text containing references shall be checked for consistency when validation is run manually
      • NO_UPDATE

        public static final UpdateMode NO_UPDATE
        Text containing references shall not be updated if referred element changes
    • Method Detail

      • values

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

        public static UpdateMode 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
      • getUpdateMode

        public static UpdateMode getUpdateMode​(java.lang.String name,
                                               UpdateMode defaultValue)