org.apache.commons.vfs2
Class FileSystemConfigBuilder

java.lang.Object
  extended by org.apache.commons.vfs2.FileSystemConfigBuilder
Direct Known Subclasses:
DefaultFileSystemConfigBuilder, FtpFileSystemConfigBuilder, FtpsFileSystemConfigBuilder, HttpFileSystemConfigBuilder, RamFileSystemConfigBuilder, ResourceFileSystemConfigBuilder, SftpFileSystemConfigBuilder

public abstract class FileSystemConfigBuilder
extends Object

Abstract class which has the right to fill FileSystemOptions.

Author:
Commons VFS team

Constructor Summary
protected FileSystemConfigBuilder()
           
protected FileSystemConfigBuilder(String component)
           
 
Method Summary
protected  Boolean getBoolean(FileSystemOptions opts, String name)
           
protected  boolean getBoolean(FileSystemOptions opts, String name, boolean defaultValue)
           
protected  Boolean getBoolean(FileSystemOptions opts, String name, Boolean defaultValue)
           
protected  Byte getByte(FileSystemOptions opts, String name)
           
protected  byte getByte(FileSystemOptions opts, String name, byte defaultValue)
           
protected  Byte getByte(FileSystemOptions opts, String name, Byte defaultValue)
           
protected  Character getCharacter(FileSystemOptions opts, String name)
           
protected  char getCharacter(FileSystemOptions opts, String name, char defaultValue)
           
protected  Character getCharacter(FileSystemOptions opts, String name, Character defaultValue)
           
protected abstract  Class<? extends FileSystem> getConfigClass()
           
protected  Double getDouble(FileSystemOptions opts, String name)
           
protected  double getDouble(FileSystemOptions opts, String name, double defaultValue)
           
protected  Double getDouble(FileSystemOptions opts, String name, Double defaultValue)
           
protected  Float getFloat(FileSystemOptions opts, String name)
           
protected  float getFloat(FileSystemOptions opts, String name, float defaultValue)
           
protected  Float getFloat(FileSystemOptions opts, String name, Float defaultValue)
           
protected  Integer getInteger(FileSystemOptions opts, String name)
           
protected  int getInteger(FileSystemOptions opts, String name, int defaultValue)
           
protected  Integer getInteger(FileSystemOptions opts, String name, Integer defaultValue)
           
protected  Long getLong(FileSystemOptions opts, String name)
           
protected  long getLong(FileSystemOptions opts, String name, long defaultValue)
           
protected  Long getLong(FileSystemOptions opts, String name, Long defaultValue)
           
protected  Object getParam(FileSystemOptions opts, String name)
           
 String getRootURI(FileSystemOptions opts)
          Return the root URI of the file system.
protected  Short getShort(FileSystemOptions opts, String name)
           
protected  short getShort(FileSystemOptions opts, String name, short defaultValue)
           
protected  Short getShort(FileSystemOptions opts, String name, Short defaultValue)
           
protected  String getString(FileSystemOptions opts, String name)
           
protected  String getString(FileSystemOptions opts, String name, String defaultValue)
           
protected  boolean hasObject(FileSystemOptions opts, String name)
           
protected  boolean hasParam(FileSystemOptions opts, String name)
           
protected  void setParam(FileSystemOptions opts, String name, Object value)
           
 void setRootURI(FileSystemOptions opts, String rootURI)
          The root URI of the file system.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileSystemConfigBuilder

protected FileSystemConfigBuilder()

FileSystemConfigBuilder

protected FileSystemConfigBuilder(String component)
Since:
2.0
Method Detail

setRootURI

public void setRootURI(FileSystemOptions opts,
                       String rootURI)
The root URI of the file system.

Parameters:
opts - The FileSystem options
rootURI - The creator name to be associated with the file.
Since:
2.0

getRootURI

public String getRootURI(FileSystemOptions opts)
Return the root URI of the file system.

Parameters:
opts - The FileSystem options
Returns:
The root URI.
Since:
2.0

setParam

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

getParam

protected Object getParam(FileSystemOptions opts,
                          String name)

hasParam

protected boolean hasParam(FileSystemOptions opts,
                           String name)

hasObject

protected boolean hasObject(FileSystemOptions opts,
                            String name)
Since:
2.0

getBoolean

protected Boolean getBoolean(FileSystemOptions opts,
                             String name)
Since:
2.0

getBoolean

protected boolean getBoolean(FileSystemOptions opts,
                             String name,
                             boolean defaultValue)
Since:
2.0

getBoolean

protected Boolean getBoolean(FileSystemOptions opts,
                             String name,
                             Boolean defaultValue)
Since:
2.0

getByte

protected Byte getByte(FileSystemOptions opts,
                       String name)
Since:
2.0

getByte

protected byte getByte(FileSystemOptions opts,
                       String name,
                       byte defaultValue)
Since:
2.0

getByte

protected Byte getByte(FileSystemOptions opts,
                       String name,
                       Byte defaultValue)
Since:
2.0

getCharacter

protected Character getCharacter(FileSystemOptions opts,
                                 String name)
Since:
2.0

getCharacter

protected char getCharacter(FileSystemOptions opts,
                            String name,
                            char defaultValue)
Since:
2.0

getCharacter

protected Character getCharacter(FileSystemOptions opts,
                                 String name,
                                 Character defaultValue)
Since:
2.0

getDouble

protected Double getDouble(FileSystemOptions opts,
                           String name)
Since:
2.0

getDouble

protected double getDouble(FileSystemOptions opts,
                           String name,
                           double defaultValue)
Since:
2.0

getDouble

protected Double getDouble(FileSystemOptions opts,
                           String name,
                           Double defaultValue)
Since:
2.0

getFloat

protected Float getFloat(FileSystemOptions opts,
                         String name)
Since:
2.0

getFloat

protected float getFloat(FileSystemOptions opts,
                         String name,
                         float defaultValue)
Since:
2.0

getFloat

protected Float getFloat(FileSystemOptions opts,
                         String name,
                         Float defaultValue)
Since:
2.0

getInteger

protected Integer getInteger(FileSystemOptions opts,
                             String name)
Since:
2.0

getInteger

protected int getInteger(FileSystemOptions opts,
                         String name,
                         int defaultValue)
Since:
2.0

getInteger

protected Integer getInteger(FileSystemOptions opts,
                             String name,
                             Integer defaultValue)
Since:
2.0

getLong

protected Long getLong(FileSystemOptions opts,
                       String name)
Since:
2.0

getLong

protected long getLong(FileSystemOptions opts,
                       String name,
                       long defaultValue)
Since:
2.0

getLong

protected Long getLong(FileSystemOptions opts,
                       String name,
                       Long defaultValue)
Since:
2.0

getShort

protected Short getShort(FileSystemOptions opts,
                         String name)
Since:
2.0

getShort

protected short getShort(FileSystemOptions opts,
                         String name,
                         short defaultValue)
Since:
2.0

getShort

protected Short getShort(FileSystemOptions opts,
                         String name,
                         Short defaultValue)
Since:
2.0

getString

protected String getString(FileSystemOptions opts,
                           String name)
Since:
2.0

getString

protected String getString(FileSystemOptions opts,
                           String name,
                           String defaultValue)
Since:
2.0

getConfigClass

protected abstract Class<? extends FileSystem> getConfigClass()


Copyright © 2002-2012 The Apache Software Foundation. All Rights Reserved.