org.apache.commons.vfs2

Enum CacheStrategy

java.lang.Object

java.lang.Enum<CacheStrategy>

org.apache.commons.vfs2.CacheStrategy

All Implemented Interfaces:

Serializable, Comparable<CacheStrategy>

public enum CacheStrategy
extends Enum<CacheStrategy>

An enumerated type to deal with the various cache strategies.

Version:

$Revision: 1035170 $ $Date: 2010-11-15 13:31:58 +0530 (Mon, 15 Nov 2010) $

Author:

Commons VFS team

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANUAL Deal with cached data manually.
ON_CALL Refresh the data every time you call a method on the fileObject.
ON_RESOLVE Refresh the data every time you request a file from FileSystemManager.resolveFile(java.lang.String).

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the name of the scope.
String	toString() Returns the name of the scope.
static CacheStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static CacheStrategy[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MANUAL

public static final CacheStrategy MANUAL

Deal with cached data manually. Call FileObject.refresh() to refresh the object data.

ON_RESOLVE

public static final CacheStrategy ON_RESOLVE

Refresh the data every time you request a file from FileSystemManager.resolveFile(java.lang.String).

ON_CALL

public static final CacheStrategy ON_CALL

Refresh the data every time you call a method on the fileObject. You'll use this only if you really need the latest info as this setting is a major performance loss.

Method Detail

values

public static CacheStrategy[] 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 (CacheStrategy c : CacheStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

toString

public String toString()

Returns the name of the scope.

Overrides:

toString in class Enum<CacheStrategy>

Returns:

the name of the scope.

getName

public String getName()

Returns the name of the scope.

Returns:

the name of the scope.