Package org.apache.commons.vfs2.util
Enum RandomAccessMode
- java.lang.Object
-
- java.lang.Enum<RandomAccessMode>
-
- org.apache.commons.vfs2.util.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
.
-
-
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 ofAccessMode
into a RandomAccessMode.java.lang.String
getModeString()
boolean
requestRead()
Tests the read flag.boolean
requestWrite()
Tests the write flag.java.nio.file.AccessMode[]
toAccessModes()
Converts this instance to an array ofAccessMode
.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.
-
-
-
Enum Constant Detail
-
READ
public static final RandomAccessMode READ
Read access mode.
-
READWRITE
public static final RandomAccessMode READWRITE
Read-write access mode.
-
-
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 namejava.lang.NullPointerException
- if the argument is null
-
from
public static RandomAccessMode from(java.nio.file.AccessMode... accessModes)
Converts an array ofAccessMode
into a RandomAccessMode.- Parameters:
accessModes
- AccessMode array, onlyAccessMode.READ
andAccessMode.WRITE
are supported.- Returns:
- A RandomAccessMode.
- Since:
- 2.10.0
-
getModeString
public java.lang.String getModeString()
-
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 ofAccessMode
.- Returns:
- an array of
AccessMode
. - Since:
- 2.10.0
-
-