public final class FileSystemOptions
extends java.lang.Object
implements java.lang.Cloneable
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.
DefaultFileSystemConfigBuilder
,
FtpFileSystemConfigBuilder
,
org.apache.commons.vfs2.provider.ftps.FtpsFileSystemConfigBuilder
,
org.apache.commons.vfs2.provider.hdfs.HdfsFileSystemConfigBuilder
,
HttpFileSystemConfigBuilder
,
org.apache.commons.vfs2.provider.webdav.WebdavFileSystemConfigBuilder
,
RamFileSystemConfigBuilder
,
ResourceFileSystemConfigBuilder
,
SftpFileSystemConfigBuilder
,
ZipFileSystemConfigBuilder
Modifier and Type | Class and Description |
---|---|
private static class |
FileSystemOptions.FileSystemOptionKey
Keys in the options Map.
|
Modifier and Type | Field and Description |
---|---|
private java.util.Map<FileSystemOptions.FileSystemOptionKey,java.lang.Object> |
options
The options
|
Modifier | Constructor and Description |
---|---|
|
FileSystemOptions()
Creates a new instance.
|
protected |
FileSystemOptions(java.util.Map<FileSystemOptions.FileSystemOptionKey,java.lang.Object> options) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
int |
compareTo(FileSystemOptions other) |
boolean |
equals(java.lang.Object obj) |
(package private) java.lang.Object |
getOption(java.lang.Class<? extends FileSystem> fileSystemClass,
java.lang.String name) |
int |
hashCode() |
(package private) boolean |
hasOption(java.lang.Class<? extends FileSystem> fileSystemClass,
java.lang.String name) |
(package private) void |
setOption(java.lang.Class<? extends FileSystem> fileSystemClass,
java.lang.String name,
java.lang.Object value) |
java.lang.String |
toString() |
private final java.util.Map<FileSystemOptions.FileSystemOptionKey,java.lang.Object> options
public FileSystemOptions()
protected FileSystemOptions(java.util.Map<FileSystemOptions.FileSystemOptionKey,java.lang.Object> options)
void setOption(java.lang.Class<? extends FileSystem> fileSystemClass, java.lang.String name, java.lang.Object value)
java.lang.Object getOption(java.lang.Class<? extends FileSystem> fileSystemClass, java.lang.String name)
boolean hasOption(java.lang.Class<? extends FileSystem> fileSystemClass, java.lang.String name)
public int compareTo(FileSystemOptions other)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object