org.apache.commons.vfs2

Enum Capability

java.lang.Object

java.lang.Enum<Capability>

org.apache.commons.vfs2.Capability

All Implemented Interfaces:

Serializable, Comparable<Capability>

public enum Capability
extends Enum<Capability>

An enumerated type representing the capabilities of files and file systems.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEND_CONTENT File content can be appended.
ATTRIBUTES File attributes are supported.
COMPRESS A compressed file system is a file system which use compression.
CREATE Files can be created.
DELETE Files can be deleted.
DIRECTORY_READ_CONTENT Provides directories which allows you to read its content through FileContent.getInputStream().
DISPATCHER The provider itself do not provide a file system.
FS_ATTRIBUTES File system attributes are supported.
GET_LAST_MODIFIED File get last-modified time is supported.
GET_TYPE The file type can be determined.
JUNCTIONS Junctions are supported.
LAST_MODIFIED File last-modified time is supported.
LIST_CHILDREN Children of files can be listed.
MANIFEST_ATTRIBUTES The set of attributes defined by the Jar manifest specification are supported.
RANDOM_ACCESS_READ File content can be read in random mode.
RANDOM_ACCESS_SET_LENGTH File content length can be set in random mode.
RANDOM_ACCESS_WRITE File content can be written in random mode.
READ_CONTENT File content can be read.
RENAME Files can be renamed.
SET_LAST_MODIFIED_FILE File set last-modified time is supported.
SET_LAST_MODIFIED_FOLDER folder set last-modified time is supported.
SIGNING File content signing is supported.
URI URI are supported.
VIRTUAL A virtual file system can be an archive like tar or zip.
WRITE_CONTENT File content can be written.

Method Summary

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

public static final Capability READ_CONTENT

File content can be read.

WRITE_CONTENT

public static final Capability WRITE_CONTENT

File content can be written.

RANDOM_ACCESS_READ

public static final Capability RANDOM_ACCESS_READ

File content can be read in random mode.

RANDOM_ACCESS_SET_LENGTH

public static final Capability RANDOM_ACCESS_SET_LENGTH

File content length can be set in random mode.

RANDOM_ACCESS_WRITE

public static final Capability RANDOM_ACCESS_WRITE

File content can be written in random mode.

APPEND_CONTENT

public static final Capability APPEND_CONTENT

File content can be appended.

ATTRIBUTES

public static final Capability ATTRIBUTES

File attributes are supported.

LAST_MODIFIED

public static final Capability LAST_MODIFIED

File last-modified time is supported.

GET_LAST_MODIFIED

public static final Capability GET_LAST_MODIFIED

File get last-modified time is supported.

SET_LAST_MODIFIED_FILE

public static final Capability SET_LAST_MODIFIED_FILE

File set last-modified time is supported.

SET_LAST_MODIFIED_FOLDER

public static final Capability SET_LAST_MODIFIED_FOLDER

folder set last-modified time is supported.

SIGNING

public static final Capability SIGNING

File content signing is supported.

CREATE

public static final Capability CREATE

Files can be created.

DELETE

public static final Capability DELETE

Files can be deleted.

RENAME

public static final Capability RENAME

Files can be renamed.

GET_TYPE

public static final Capability GET_TYPE

The file type can be determined.

LIST_CHILDREN

public static final Capability LIST_CHILDREN

Children of files can be listed.

URI

public static final Capability URI

URI are supported. Files without this capability use URI that do not globally and uniquely identify the file.

FS_ATTRIBUTES

public static final Capability FS_ATTRIBUTES

File system attributes are supported.

JUNCTIONS

public static final Capability JUNCTIONS

Junctions are supported.

MANIFEST_ATTRIBUTES

public static final Capability MANIFEST_ATTRIBUTES

The set of attributes defined by the Jar manifest specification are supported. The attributes aren't necessarily stored in a manifest file.

DISPATCHER

public static final Capability DISPATCHER

The provider itself do not provide a file system. It simply resolves a full name and dispatches the request back to the file system manager.

A provider with this capability cant tell much about the capabilities about the finally used file system in advance.

COMPRESS

public static final Capability COMPRESS

A compressed file system is a file system which use compression.

VIRTUAL

public static final Capability VIRTUAL

A virtual file system can be an archive like tar or zip.

DIRECTORY_READ_CONTENT

public static final Capability DIRECTORY_READ_CONTENT

Provides directories which allows you to read its content through FileContent.getInputStream().

Since:

2.0

Method Detail

values

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

Returns:

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

valueOf

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