org.apache.commons.vfs2

Class FileSystemConfigBuilder

java.lang.Object

org.apache.commons.vfs2.FileSystemConfigBuilder

Direct Known Subclasses:

DefaultFileSystemConfigBuilder, FtpFileSystemConfigBuilder, HdfsFileSystemConfigBuilder, Http4FileSystemConfigBuilder, Http5FileSystemConfigBuilder, HttpFileSystemConfigBuilder, RamFileSystemConfigBuilder, ResourceFileSystemConfigBuilder, SftpFileSystemConfigBuilder, ZipFileSystemConfigBuilder

public abstract class FileSystemConfigBuilder
extends Object

Abstract class which has the right to fill FileSystemOptions.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSystemConfigBuilder() Constructs builder with default prefix.
protected	FileSystemConfigBuilder(String component) Constructs builder with specified component name.

Method Summary

Modifier and Type	Method and Description
protected Boolean	getBoolean(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Boolean.
protected boolean	getBoolean(FileSystemOptions fileSystemOptions, String name, boolean defaultValue) Gets a named option as a Boolean.
protected Boolean	getBoolean(FileSystemOptions fileSystemOptions, String name, Boolean defaultValue) Gets a named option as a Boolean.
protected Byte	getByte(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Byte.
protected byte	getByte(FileSystemOptions fileSystemOptions, String name, byte defaultValue) Gets a named option as a Byte.
protected Byte	getByte(FileSystemOptions fileSystemOptions, String name, Byte defaultValue) Gets a named option as a Byte.
protected Character	getCharacter(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Character.
protected char	getCharacter(FileSystemOptions fileSystemOptions, String name, char defaultValue) Gets a named option as a Character.
protected Character	getCharacter(FileSystemOptions fileSystemOptions, String name, Character defaultValue) Gets a named option as a Character.
protected abstract Class<? extends FileSystem>	getConfigClass() Gets the target of this configuration.
protected Double	getDouble(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Double.
protected double	getDouble(FileSystemOptions fileSystemOptions, String name, double defaultValue) Gets a named option as a Double.
protected Double	getDouble(FileSystemOptions fileSystemOptions, String name, Double defaultValue) Gets a named option as a Double.
protected Duration	getDuration(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Duration.
protected Duration	getDuration(FileSystemOptions fileSystemOptions, String name, Duration defaultValue) Gets a named option as a Duration.
protected Integer	getDurationInteger(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Duration bound to the integer range.
protected Integer	getDurationInteger(FileSystemOptions fileSystemOptions, String name, Duration defaultValue) Gets a named option as a Duration bound to the integer range.
protected <E extends Enum<E>> E	getEnum(Class<E> enumClass, FileSystemOptions fileSystemOptions, String name) Gets a named option as a Double.
protected <E extends Enum<E>> E	getEnum(Class<E> enumClass, FileSystemOptions fileSystemOptions, String name, E defaultValue) Gets a named option as an Enum.
protected Float	getFloat(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Float.
protected float	getFloat(FileSystemOptions fileSystemOptions, String name, float defaultValue) Gets a named option as a Float.
protected Float	getFloat(FileSystemOptions fileSystemOptions, String name, Float defaultValue) Gets a named option as a Float.
protected Integer	getInteger(FileSystemOptions fileSystemOptions, String name) Gets a named option as an Integer.
protected int	getInteger(FileSystemOptions fileSystemOptions, String name, int defaultValue) Gets a named option as an Integer.
protected Integer	getInteger(FileSystemOptions fileSystemOptions, String name, Integer defaultValue) Gets a named option as an Integer.
protected Long	getLong(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Long.
protected long	getLong(FileSystemOptions fileSystemOptions, String name, long defaultValue) Gets a named option as a Long.
protected Long	getLong(FileSystemOptions fileSystemOptions, String name, Long defaultValue) Gets a named option as a Long.
protected <T> T	getParam(FileSystemOptions fileSystemOptions, String name) Gets a named parameter.
String	getRootURI(FileSystemOptions fileSystemOptions) Gets the root URI of the file system.
protected Short	getShort(FileSystemOptions fileSystemOptions, String name) Gets a named option as a Short.
protected short	getShort(FileSystemOptions fileSystemOptions, String name, short defaultValue) Gets a named option as a Short.
protected Short	getShort(FileSystemOptions fileSystemOptions, String name, Short defaultValue) Gets a named option as a Short.
protected String	getString(FileSystemOptions fileSystemOptions, String name) Gets a named option as a String.
protected String	getString(FileSystemOptions fileSystemOptions, String name, String defaultValue) Gets a named option as a String.
protected boolean	hasObject(FileSystemOptions fileSystemOptions, String name) Checks the named setting specified.
protected boolean	hasParam(FileSystemOptions fileSystemOptions, String name) Checks if option exists.
protected void	setParam(FileSystemOptions fileSystemOptions, String name, boolean value) Sets the named parameter.
protected void	setParam(FileSystemOptions fileSystemOptions, String name, Object value) Sets the named parameter.
void	setRootURI(FileSystemOptions fileSystemOptions, String rootURI) Sets the root URI of the file system.
protected Boolean	toBooleanObject(boolean value) Converts the given primitive boolean to a Boolean object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemConfigBuilder

protected FileSystemConfigBuilder()

Constructs builder with default prefix.

Since:

1.0

FileSystemConfigBuilder

protected FileSystemConfigBuilder(String component)

Constructs builder with specified component name.

Parameters:

component - component name to be used in prefix

Since:

2.0

Method Detail

getBoolean

protected Boolean getBoolean(FileSystemOptions fileSystemOptions,
                             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,
                             String name,
                             boolean defaultValue)

Gets a named option as a Boolean.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.0

See Also:

getBoolean(FileSystemOptions, String, Boolean)

getBoolean

protected Boolean getBoolean(FileSystemOptions fileSystemOptions,
                             String name,
                             Boolean defaultValue)

Gets a named option as a Boolean.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.0

See Also:

getBoolean(FileSystemOptions, String, Boolean)

getByte

protected Byte getByte(FileSystemOptions fileSystemOptions,
                       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,
                       String name,
                       byte defaultValue)

Gets a named option as a Byte.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.0

See Also:

getByte(FileSystemOptions, String, Byte)

getByte

protected Byte getByte(FileSystemOptions fileSystemOptions,
                       String name,
                       Byte defaultValue)

Gets a named option as a Byte.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.0

getCharacter

protected Character getCharacter(FileSystemOptions fileSystemOptions,
                                 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,
                            String name,
                            char defaultValue)

Gets a named option as a Character.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.0

See Also:

getCharacter(FileSystemOptions, String, Character)

getCharacter

protected Character getCharacter(FileSystemOptions fileSystemOptions,
                                 String name,
                                 Character defaultValue)

Gets a named option as a Character.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.0

getConfigClass

protected abstract Class<? extends FileSystem> getConfigClass()

Gets the target of this configuration.

Returns:

the specific file system class

Since:

1.0

getDouble

protected Double getDouble(FileSystemOptions fileSystemOptions,
                           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,
                           String name,
                           double defaultValue)

Gets a named option as a Double.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.0

See Also:

getDouble(FileSystemOptions, String, Double)

getDouble

protected Double getDouble(FileSystemOptions fileSystemOptions,
                           String name,
                           Double defaultValue)

Gets a named option as a Double.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.0

getDuration

protected Duration getDuration(FileSystemOptions fileSystemOptions,
                               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 Duration getDuration(FileSystemOptions fileSystemOptions,
                               String name,
                               Duration defaultValue)

Gets a named option as a Duration.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.8.0

getDurationInteger

protected Integer getDurationInteger(FileSystemOptions fileSystemOptions,
                                     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 Integer getDurationInteger(FileSystemOptions fileSystemOptions,
                                     String name,
                                     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 name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.8.0

getEnum

protected <E extends Enum<E>> E getEnum(Class<E> enumClass,
                                        FileSystemOptions fileSystemOptions,
                                        String name)

Gets a named option as a Double.

Type Parameters:

E - enumeration type

Parameters:

enumClass - class of enumeration type

fileSystemOptions - file system options to query, may be null.

name - the option name *

Returns:

the option in opts or system properties, otherwise null

Throws:

IllegalArgumentException - if option value is not a known enumeration.

Since:

2.1

See Also:

getEnum(Class, FileSystemOptions, String, Enum)

getEnum

protected <E extends Enum<E>> E getEnum(Class<E> enumClass,
                                        FileSystemOptions fileSystemOptions,
                                        String name,
                                        E defaultValue)

Gets a named option as an Enum.

Type Parameters:

E - enumeration type

Parameters:

enumClass - class of enumeration type

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Throws:

IllegalArgumentException - if option value is not a known enumeration.

Since:

2.1

See Also:

getEnum(Class, FileSystemOptions, String, Enum)

getFloat

protected Float getFloat(FileSystemOptions fileSystemOptions,
                         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:

NumberFormatException - if option value is not a valid float.

Since:

2.0

See Also:

getFloat(FileSystemOptions, String, Float)

getFloat

protected float getFloat(FileSystemOptions fileSystemOptions,
                         String name,
                         float defaultValue)

Gets a named option as a Float.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Throws:

NumberFormatException - if option value is not a valid float.

Since:

2.0

See Also:

getFloat(FileSystemOptions, String, Float)

getFloat

protected Float getFloat(FileSystemOptions fileSystemOptions,
                         String name,
                         Float defaultValue)

Gets a named option as a Float.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Throws:

NumberFormatException - if option value is not a valid float.

Since:

2.0

getInteger

protected Integer getInteger(FileSystemOptions fileSystemOptions,
                             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:

NumberFormatException - if option value is not a valid integer.

Since:

2.0

See Also:

getInteger(FileSystemOptions, String, Integer)

getInteger

protected int getInteger(FileSystemOptions fileSystemOptions,
                         String name,
                         int defaultValue)

Gets a named option as an Integer.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Throws:

NumberFormatException - if option value is not a valid integer.

Since:

2.0

See Also:

getInteger(FileSystemOptions, String, Integer)

getInteger

protected Integer getInteger(FileSystemOptions fileSystemOptions,
                             String name,
                             Integer defaultValue)

Gets a named option as an Integer.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Throws:

NumberFormatException - if option value is not a valid integer.

Since:

2.0

getLong

protected Long getLong(FileSystemOptions fileSystemOptions,
                       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:

NumberFormatException - if option value is not a valid long.

Since:

2.0

See Also:

getLong(FileSystemOptions, String, Long)

getLong

protected long getLong(FileSystemOptions fileSystemOptions,
                       String name,
                       long defaultValue)

Gets a named option as a Long.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Throws:

NumberFormatException - if option value is not a valid long.

Since:

2.0

See Also:

getLong(FileSystemOptions, String, Long)

getLong

protected Long getLong(FileSystemOptions fileSystemOptions,
                       String name,
                       Long defaultValue)

Gets a named option as a Long.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Throws:

NumberFormatException - if option value is not a valid long.

Since:

2.0

getParam

protected <T> T getParam(FileSystemOptions fileSystemOptions,
                         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

getRootURI

public 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 Short getShort(FileSystemOptions fileSystemOptions,
                         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:

NumberFormatException - if option value is not a valid short.

Since:

2.0

See Also:

getShort(FileSystemOptions, String, Short)

getShort

protected short getShort(FileSystemOptions fileSystemOptions,
                         String name,
                         short defaultValue)

Gets a named option as a Short.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Throws:

NumberFormatException - if option value is not a valid short

Since:

2.0

See Also:

getShort(FileSystemOptions, String, Short)

getShort

protected Short getShort(FileSystemOptions fileSystemOptions,
                         String name,
                         Short defaultValue)

Gets a named option as a Short.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Throws:

NumberFormatException - if option value is not a valid short

Since:

2.0

getString

protected String getString(FileSystemOptions fileSystemOptions,
                           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 String getString(FileSystemOptions fileSystemOptions,
                           String name,
                           String defaultValue)

Gets a named option as a String.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option name

defaultValue - value to return if option is not present

Returns:

the option in opts or system properties, otherwise defaultValue

Since:

2.0

hasObject

protected boolean hasObject(FileSystemOptions fileSystemOptions,
                            String name)

Checks the named setting specified.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the option to check in opts or system properties

Returns:

true if option exists

Since:

2.0

hasParam

protected boolean hasParam(FileSystemOptions fileSystemOptions,
                           String name)

Checks if option exists.

Parameters:

fileSystemOptions - file system options to query, may be null.

name - the name to look up in opts

Returns:

true if opts have the named parameter

Since:

1.0

setParam

protected void setParam(FileSystemOptions fileSystemOptions,
                        String name,
                        boolean value)

Sets the named parameter.

Parameters:

fileSystemOptions - the file system options to modify

name - set option with this name

value - boolean value to set

Since:

2.1

setParam

protected void setParam(FileSystemOptions fileSystemOptions,
                        String name,
                        Object value)

Sets the named parameter.

Parameters:

fileSystemOptions - the file system options to modify

name - set option with this name

value - object value to set

Since:

1.0

setRootURI

public void setRootURI(FileSystemOptions fileSystemOptions,
                       String rootURI)

Sets the root URI of the file system.

Parameters:

fileSystemOptions - the file system options to modify

rootURI - The creator name to be associated with the file.

Since:

2.0

toBooleanObject

protected 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