Package org.apache.commons.vfs2

Class FileSystemOptions

java.lang.Object

org.apache.commons.vfs2.FileSystemOptions

All Implemented Interfaces:

Cloneable, Comparable<FileSystemOptions>

public final class FileSystemOptions
extends Object
implements Cloneable, Comparable<FileSystemOptions>

Configures file systems individually with these options.

To configure a file system, you set properties on a FileSystemOptions object. Most file systems provide a FileSystemConfigBuilder with specific options for that file system.

To use the options, pass them to FileSystemManager.resolveFile(String,FileSystemOptions). From there, the options apply to all files that are resolved relative to that file.

See Also:

• DefaultFileSystemConfigBuilder
• FtpFileSystemConfigBuilder
• invalid reference

  org.apache.commons.vfs2.provider.ftps.FtpsFileSystemConfigBuilder

• invalid reference

  org.apache.commons.vfs2.provider.http.HttpFileSystemConfigBuilder

• RamFileSystemConfigBuilder
• ResourceFileSystemConfigBuilder
• SftpFileSystemConfigBuilder
• ZipFileSystemConfigBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	FileSystemOptions.FileSystemOptionKey	Keys in the options Map.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<FileSystemOptions.FileSystemOptionKey,Object>	options	The options

Constructor Summary

Constructors

Constructor	Description
FileSystemOptions()	Constructs a new instance.
FileSystemOptions(Map<FileSystemOptions.FileSystemOptionKey,Object> options)	Constructs a new instance with the given options.

Method Summary

Modifier and Type	Method	Description
Object	clone()
int	compareTo(FileSystemOptions other)
boolean	equals(Object obj)
(package private) <T> T	getOption(Class<? extends FileSystem> fileSystemClass, String name)
(package private) <T> T	getOptionOrDefault(Class<? extends FileSystem> fileSystemClass, String name, T defaultValue)
int	hashCode()
(package private) boolean	hasOption(Class<? extends FileSystem> fileSystemClass, String name)
(package private) void	setOption(Class<? extends FileSystem> fileSystemClass, String name, Object value)
(package private) int	size()
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

options

private final Map<FileSystemOptions.FileSystemOptionKey,Object> options

The options

Constructor Details

FileSystemOptions

public FileSystemOptions()

Constructs a new instance.

FileSystemOptions

public FileSystemOptions(Map<FileSystemOptions.FileSystemOptionKey,Object> options)

Constructs a new instance with the given options.

Parameters:

options - the options.

Since:

2.10.0

Method Details

clone

public Object clone()

Overrides:

clone in class Object

Since:

2.0

compareTo

public int compareTo(FileSystemOptions other)

Specified by:

compareTo in interface Comparable<FileSystemOptions>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getOption

<T> T getOption(Class<? extends FileSystem> fileSystemClass,
 String name)

getOptionOrDefault

<T> T getOptionOrDefault(Class<? extends FileSystem> fileSystemClass,
 String name,
 T defaultValue)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasOption

boolean hasOption(Class<? extends FileSystem> fileSystemClass,
 String name)

setOption

void setOption(Class<? extends FileSystem> fileSystemClass,
 String name,
 Object value)

size

int size()

toString

public String toString()

Overrides:

toString in class Object