Package org.apache.commons.vfs2.util

Enum RandomAccessMode

java.lang.Object
java.lang.Enum<RandomAccessMode>
org.apache.commons.vfs2.util.RandomAccessMode
All Implemented Interfaces:
Serializable, Comparable<RandomAccessMode>
public enum RandomAccessMode extends Enum<RandomAccessMode>
An enumerated type representing the modes of a random access content.

TODO Replace with AccessMode.

  • Enum Constant Details

  • Field Details

    • ACCESS_MODE_READ

      private static final AccessMode[] ACCESS_MODE_READ

    • ACCESS_MODE_READ_WRITE

      private static final AccessMode[] ACCESS_MODE_READ_WRITE

    • read

      private final boolean read

    • write

      private final boolean write

  • Constructor Details

    • RandomAccessMode

      private RandomAccessMode(boolean read, boolean write)

  • Method Details

    • values

      public static RandomAccessMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static RandomAccessMode valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • from

      public static RandomAccessMode from(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 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 AccessMode[] toAccessModes()
      Converts this instance to an array of AccessMode.
      Returns:
      an array of AccessMode.
      Since:
      2.10.0