org.apache.commons.vfs2.util
Enum RandomAccessMode

java.lang.Object
  extended by java.lang.Enum<RandomAccessMode>
      extended by 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.

Author:
Commons VFS team

Enum Constant Summary
READ
          read.
READWRITE
          read/write.
 
Method Summary
 String getModeString()
           
 boolean requestRead()
           
 boolean requestWrite()
           
static RandomAccessMode valueOf(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
 

Enum Constant Detail

READ

public static final RandomAccessMode READ
read.


READWRITE

public static final RandomAccessMode READWRITE
read/write.

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(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

requestRead

public boolean requestRead()

requestWrite

public boolean requestWrite()

getModeString

public String getModeString()
Returns:
The mode String.
Since:
2.0


Copyright © 2002-2012 The Apache Software Foundation. All Rights Reserved.