Package org.apache.commons.vfs2
Class FileSystemConfigBuilder
- java.lang.Object
-
- org.apache.commons.vfs2.FileSystemConfigBuilder
-
- Direct Known Subclasses:
DefaultFileSystemConfigBuilder
,FtpFileSystemConfigBuilder
,Http4FileSystemConfigBuilder
,HttpFileSystemConfigBuilder
,RamFileSystemConfigBuilder
,ResourceFileSystemConfigBuilder
,SftpFileSystemConfigBuilder
,ZipFileSystemConfigBuilder
public abstract class FileSystemConfigBuilder extends java.lang.Object
Abstracts configuringFileSystemOptions
s.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FileSystemConfigBuilder()
Constructs builder with default prefix.protected
FileSystemConfigBuilder(java.lang.String component)
Constructs builder with specified component name.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected java.lang.Boolean
getBoolean(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Boolean.protected boolean
getBoolean(FileSystemOptions fileSystemOptions, java.lang.String name, boolean defaultValue)
Gets a named option as a Boolean.protected java.lang.Boolean
getBoolean(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Boolean defaultValue)
Gets a named option as a Boolean.protected java.lang.Byte
getByte(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Byte.protected byte
getByte(FileSystemOptions fileSystemOptions, java.lang.String name, byte defaultValue)
Gets a named option as a Byte.protected java.lang.Byte
getByte(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Byte defaultValue)
Gets a named option as a Byte.protected java.lang.Character
getCharacter(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Character.protected char
getCharacter(FileSystemOptions fileSystemOptions, java.lang.String name, char defaultValue)
Gets a named option as a Character.protected java.lang.Character
getCharacter(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Character defaultValue)
Gets a named option as a Character.protected abstract java.lang.Class<? extends FileSystem>
getConfigClass()
Gets the target of this configuration.protected java.lang.Double
getDouble(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Double.protected double
getDouble(FileSystemOptions fileSystemOptions, java.lang.String name, double defaultValue)
Gets a named option as a Double.protected java.lang.Double
getDouble(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Double defaultValue)
Gets a named option as a Double.protected java.time.Duration
getDuration(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Duration.protected java.time.Duration
getDuration(FileSystemOptions fileSystemOptions, java.lang.String name, java.time.Duration defaultValue)
Gets a named option as a Duration.protected java.lang.Integer
getDurationInteger(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Duration bound to the integer range.protected java.lang.Integer
getDurationInteger(FileSystemOptions fileSystemOptions, java.lang.String name, java.time.Duration defaultValue)
Gets a named option as a Duration bound to the integer range.protected <E extends java.lang.Enum<E>>
EgetEnum(java.lang.Class<E> enumClass, FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Double.protected <E extends java.lang.Enum<E>>
EgetEnum(java.lang.Class<E> enumClass, FileSystemOptions fileSystemOptions, java.lang.String name, E defaultValue)
Gets a named option as an Enum.protected java.lang.Float
getFloat(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Float.protected float
getFloat(FileSystemOptions fileSystemOptions, java.lang.String name, float defaultValue)
Gets a named option as a Float.protected java.lang.Float
getFloat(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Float defaultValue)
Gets a named option as a Float.protected java.lang.Integer
getInteger(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as an Integer.protected int
getInteger(FileSystemOptions fileSystemOptions, java.lang.String name, int defaultValue)
Gets a named option as an Integer.protected java.lang.Integer
getInteger(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Integer defaultValue)
Gets a named option as an Integer.protected java.lang.Long
getLong(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Long.protected long
getLong(FileSystemOptions fileSystemOptions, java.lang.String name, long defaultValue)
Gets a named option as a Long.protected java.lang.Long
getLong(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Long defaultValue)
Gets a named option as a Long.protected <T> T
getParam(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named parameter.protected <T> T
getParamOrDefault(FileSystemOptions fileSystemOptions, java.lang.String name, T defaultValue)
Gets a named parameter.java.lang.String
getRootURI(FileSystemOptions fileSystemOptions)
Gets the root URI of the file system.protected java.lang.Short
getShort(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Short.protected short
getShort(FileSystemOptions fileSystemOptions, java.lang.String name, short defaultValue)
Gets a named option as a Short.protected java.lang.Short
getShort(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Short defaultValue)
Gets a named option as a Short.protected java.lang.String
getString(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a String.protected java.lang.String
getString(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.String defaultValue)
Gets a named option as a String.protected boolean
hasObject(FileSystemOptions fileSystemOptions, java.lang.String name)
Checks the named setting specified.protected boolean
hasParam(FileSystemOptions fileSystemOptions, java.lang.String name)
Checks if option exists.protected void
setParam(FileSystemOptions fileSystemOptions, java.lang.String name, boolean value)
Sets the named parameter.protected void
setParam(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Object value)
Sets the named parameter.void
setRootURI(FileSystemOptions fileSystemOptions, java.lang.String rootURI)
Sets the root URI of the file system.protected java.lang.Boolean
toBooleanObject(boolean value)
Converts the given primitive boolean to a Boolean object.
-
-
-
Constructor Detail
-
FileSystemConfigBuilder
protected FileSystemConfigBuilder()
Constructs builder with default prefix.- Since:
- 1.0
-
FileSystemConfigBuilder
protected FileSystemConfigBuilder(java.lang.String component)
Constructs builder with specified component name.- Parameters:
component
- component name to be used in prefix- Since:
- 2.0
-
-
Method Detail
-
getBoolean
protected java.lang.Boolean getBoolean(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Boolean.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Since:
- 2.0
- See Also:
getBoolean(FileSystemOptions, String, Boolean)
-
getBoolean
protected boolean getBoolean(FileSystemOptions fileSystemOptions, java.lang.String name, boolean defaultValue)
Gets a named option as a Boolean.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.0
- See Also:
getBoolean(FileSystemOptions, String, Boolean)
-
getBoolean
protected java.lang.Boolean getBoolean(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Boolean defaultValue)
Gets a named option as a Boolean.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.0
- See Also:
getBoolean(FileSystemOptions, String, Boolean)
-
getByte
protected java.lang.Byte getByte(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Byte.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Since:
- 2.0
- See Also:
getByte(FileSystemOptions, String, Byte)
-
getByte
protected byte getByte(FileSystemOptions fileSystemOptions, java.lang.String name, byte defaultValue)
Gets a named option as a Byte.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.0
- See Also:
getByte(FileSystemOptions, String, Byte)
-
getByte
protected java.lang.Byte getByte(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Byte defaultValue)
Gets a named option as a Byte.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.0
-
getCharacter
protected java.lang.Character getCharacter(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Character.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Since:
- 2.0
- See Also:
getCharacter(FileSystemOptions, String, Character)
-
getCharacter
protected char getCharacter(FileSystemOptions fileSystemOptions, java.lang.String name, char defaultValue)
Gets a named option as a Character.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.0
- See Also:
getCharacter(FileSystemOptions, String, Character)
-
getCharacter
protected java.lang.Character getCharacter(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Character defaultValue)
Gets a named option as a Character.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.0
-
getConfigClass
protected abstract java.lang.Class<? extends FileSystem> getConfigClass()
Gets the target of this configuration.- Returns:
- the specific file system class
- Since:
- 1.0
-
getDouble
protected java.lang.Double getDouble(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Double.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Since:
- 2.0
- See Also:
getDouble(FileSystemOptions, String, Double)
-
getDouble
protected double getDouble(FileSystemOptions fileSystemOptions, java.lang.String name, double defaultValue)
Gets a named option as a Double.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.0
- See Also:
getDouble(FileSystemOptions, String, Double)
-
getDouble
protected java.lang.Double getDouble(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Double defaultValue)
Gets a named option as a Double.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.0
-
getDuration
protected java.time.Duration getDuration(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Duration.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Since:
- 2.8.0
- See Also:
getLong(FileSystemOptions, String, Long)
-
getDuration
protected java.time.Duration getDuration(FileSystemOptions fileSystemOptions, java.lang.String name, java.time.Duration defaultValue)
Gets a named option as a Duration.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.8.0
-
getDurationInteger
protected java.lang.Integer getDurationInteger(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Duration bound to the integer range.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Since:
- 2.8.0
- See Also:
getLong(FileSystemOptions, String, Long)
-
getDurationInteger
protected java.lang.Integer getDurationInteger(FileSystemOptions fileSystemOptions, java.lang.String name, java.time.Duration defaultValue)
Gets a named option as a Duration bound to the integer range.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.8.0
-
getEnum
protected <E extends java.lang.Enum<E>> E getEnum(java.lang.Class<E> enumClass, FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Double.- Type Parameters:
E
- enumeration type- Parameters:
enumClass
- class of enumeration typefileSystemOptions
- file system options to query, may be null.name
- the option name *- Returns:
- the option in
opts
or system properties, otherwise null - Throws:
java.lang.IllegalArgumentException
- if option value is not a known enumeration.- Since:
- 2.1
- See Also:
getEnum(Class, FileSystemOptions, String, Enum)
-
getEnum
protected <E extends java.lang.Enum<E>> E getEnum(java.lang.Class<E> enumClass, FileSystemOptions fileSystemOptions, java.lang.String name, E defaultValue)
Gets a named option as an Enum.- Type Parameters:
E
- enumeration type- Parameters:
enumClass
- class of enumeration typefileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Throws:
java.lang.IllegalArgumentException
- if option value is not a known enumeration.- Since:
- 2.1
- See Also:
getEnum(Class, FileSystemOptions, String, Enum)
-
getFloat
protected java.lang.Float getFloat(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Float.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Throws:
java.lang.NumberFormatException
- if option value is not a valid float.- Since:
- 2.0
- See Also:
getFloat(FileSystemOptions, String, Float)
-
getFloat
protected float getFloat(FileSystemOptions fileSystemOptions, java.lang.String name, float defaultValue)
Gets a named option as a Float.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Throws:
java.lang.NumberFormatException
- if option value is not a valid float.- Since:
- 2.0
- See Also:
getFloat(FileSystemOptions, String, Float)
-
getFloat
protected java.lang.Float getFloat(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Float defaultValue)
Gets a named option as a Float.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Throws:
java.lang.NumberFormatException
- if option value is not a valid float.- Since:
- 2.0
-
getInteger
protected java.lang.Integer getInteger(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as an Integer.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Throws:
java.lang.NumberFormatException
- if option value is not a valid integer.- Since:
- 2.0
- See Also:
getInteger(FileSystemOptions, String, Integer)
-
getInteger
protected int getInteger(FileSystemOptions fileSystemOptions, java.lang.String name, int defaultValue)
Gets a named option as an Integer.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Throws:
java.lang.NumberFormatException
- if option value is not a valid integer.- Since:
- 2.0
- See Also:
getInteger(FileSystemOptions, String, Integer)
-
getInteger
protected java.lang.Integer getInteger(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Integer defaultValue)
Gets a named option as an Integer.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Throws:
java.lang.NumberFormatException
- if option value is not a valid integer.- Since:
- 2.0
-
getLong
protected java.lang.Long getLong(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Long.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Throws:
java.lang.NumberFormatException
- if option value is not a valid long.- Since:
- 2.0
- See Also:
getLong(FileSystemOptions, String, Long)
-
getLong
protected long getLong(FileSystemOptions fileSystemOptions, java.lang.String name, long defaultValue)
Gets a named option as a Long.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Throws:
java.lang.NumberFormatException
- if option value is not a valid long.- Since:
- 2.0
- See Also:
getLong(FileSystemOptions, String, Long)
-
getLong
protected java.lang.Long getLong(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Long defaultValue)
Gets a named option as a Long.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Throws:
java.lang.NumberFormatException
- if option value is not a valid long.- Since:
- 2.0
-
getParam
protected <T> T getParam(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named parameter.- Type Parameters:
T
- The expected return type.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- get option with this name- Returns:
- the named option or null
- Since:
- 1.0
-
getParamOrDefault
protected <T> T getParamOrDefault(FileSystemOptions fileSystemOptions, java.lang.String name, T defaultValue)
Gets a named parameter.- Type Parameters:
T
- The expected return type.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- get option with this namedefaultValue
- The default value if absent.- Returns:
- the named option or
defaultValue
. - Since:
- 2.10.0
-
getRootURI
public java.lang.String getRootURI(FileSystemOptions fileSystemOptions)
Gets the root URI of the file system.- Parameters:
fileSystemOptions
- file system options to query, may be null.- Returns:
- The root URI, or null.
- Since:
- 2.0
-
getShort
protected java.lang.Short getShort(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a Short.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Throws:
java.lang.NumberFormatException
- if option value is not a valid short.- Since:
- 2.0
- See Also:
getShort(FileSystemOptions, String, Short)
-
getShort
protected short getShort(FileSystemOptions fileSystemOptions, java.lang.String name, short defaultValue)
Gets a named option as a Short.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Throws:
java.lang.NumberFormatException
- if option value is not a valid short- Since:
- 2.0
- See Also:
getShort(FileSystemOptions, String, Short)
-
getShort
protected java.lang.Short getShort(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Short defaultValue)
Gets a named option as a Short.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Throws:
java.lang.NumberFormatException
- if option value is not a valid short- Since:
- 2.0
-
getString
protected java.lang.String getString(FileSystemOptions fileSystemOptions, java.lang.String name)
Gets a named option as a String.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option name- Returns:
- the option in
opts
or system properties, otherwise null - Since:
- 2.0
- See Also:
getString(FileSystemOptions, String, String)
-
getString
protected java.lang.String getString(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.String defaultValue)
Gets a named option as a String.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option namedefaultValue
- value to return if option is not present- Returns:
- the option in
opts
or system properties, otherwisedefaultValue
- Since:
- 2.0
-
hasObject
protected boolean hasObject(FileSystemOptions fileSystemOptions, java.lang.String name)
Checks the named setting specified.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the option to check inopts
or system properties- Returns:
- true if option exists
- Since:
- 2.0
-
hasParam
protected boolean hasParam(FileSystemOptions fileSystemOptions, java.lang.String name)
Checks if option exists.- Parameters:
fileSystemOptions
- file system options to query, may be null.name
- the name to look up inopts
- Returns:
- true if opts have the named parameter
- Since:
- 1.0
-
setParam
protected void setParam(FileSystemOptions fileSystemOptions, java.lang.String name, boolean value)
Sets the named parameter.- Parameters:
fileSystemOptions
- the file system options to modifyname
- set option with this namevalue
- boolean value to set- Since:
- 2.1
-
setParam
protected void setParam(FileSystemOptions fileSystemOptions, java.lang.String name, java.lang.Object value)
Sets the named parameter.- Parameters:
fileSystemOptions
- the file system options to modifyname
- set option with this namevalue
- object value to set- Since:
- 1.0
-
setRootURI
public void setRootURI(FileSystemOptions fileSystemOptions, java.lang.String rootURI)
Sets the root URI of the file system.- Parameters:
fileSystemOptions
- the file system options to modifyrootURI
- The creator name to be associated with the file.- Since:
- 2.0
-
toBooleanObject
protected java.lang.Boolean toBooleanObject(boolean value)
Converts the given primitive boolean to a Boolean object.- Parameters:
value
- a primitive boolean.- Returns:
- the given primitive boolean as Boolean object.
- Since:
- 2.7.0
-
-