Enum EditMode

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

    public enum EditMode
    extends java.lang.Enum<EditMode>
    Enumeration of edit modes.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CAPPED
      Data are inserted and replaced, but size of the file remains the same cutting out excessive data.
      EXPANDING
      Default mode expanding data when necessary.
      INPLACE
      Only overwrite edit mode is allowed and size of document cannot be changed.
      READ_ONLY
      Document cannot be changed.
    • Method Summary

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

      • READ_ONLY

        public static final EditMode READ_ONLY
        Document cannot be changed.
      • EXPANDING

        public static final EditMode EXPANDING
        Default mode expanding data when necessary. Document is extended by size of the inserted data or when replacing data overflows end of the file.
      • CAPPED

        public static final EditMode CAPPED
        Data are inserted and replaced, but size of the file remains the same cutting out excessive data.
      • INPLACE

        public static final EditMode INPLACE
        Only overwrite edit mode is allowed and size of document cannot be changed.
    • Method Detail

      • values

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

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