Enum RandomAccessMode

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

    public enum RandomAccessMode
    extends java.lang.Enum<RandomAccessMode>
    An enumerated type representing the modes of a random access content.

    TODO Replace with AccessMode.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      READ
      Read access mode.
      READWRITE
      Read-write access mode.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static RandomAccessMode from​(java.nio.file.AccessMode... accessModes)
      Converts an array of AccessMode into a RandomAccessMode.
      java.lang.String getModeString()
      Gets this instance as an access mode string suitable for other APIs, like "r" for READ and "rw" for READWRITE.
      boolean requestRead()
      Tests the read flag.
      boolean requestWrite()
      Tests the write flag.
      java.nio.file.AccessMode[] toAccessModes()
      Converts this instance to an array of AccessMode.
      static RandomAccessMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RandomAccessMode[] 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
    • Method Detail

      • values

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

        public static RandomAccessMode 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
      • from

        public static RandomAccessMode from​(java.nio.file.AccessMode... accessModes)
        Converts an array of AccessMode into a RandomAccessMode.
        Parameters:
        accessModes - AccessMode array, only AccessMode.READ and AccessMode.WRITE are supported.
        Returns:
        A RandomAccessMode.
        Since:
        2.10.0
      • getModeString

        public java.lang.String getModeString()
        Gets this instance as an access mode string suitable for other APIs, like "r" for READ and "rw" for READWRITE.
        Returns:
        An access mode String, "r" for READ and "rw" for READWRITE.
        Since:
        2.0
      • requestRead

        public boolean requestRead()
        Tests the read flag.
        Returns:
        true for read.
      • requestWrite

        public boolean requestWrite()
        Tests the write flag.
        Returns:
        true for write.
      • toAccessModes

        public java.nio.file.AccessMode[] toAccessModes()
        Converts this instance to an array of AccessMode.
        Returns:
        an array of AccessMode.
        Since:
        2.10.0