org.apache.ftpserver.ftplet
Interface Configuration

All Known Implementing Classes:
EmptyConfiguration, PropertiesConfiguration, XmlConfiguration

public interface Configuration

Configuration interface.


Method Summary
 boolean getBoolean(java.lang.String param)
          Get boolean - if not found throws FtpException.
 boolean getBoolean(java.lang.String param, boolean defaultVal)
          Get boolean - if not found returns the default value.
 double getDouble(java.lang.String param)
          Get double - if not found throws FtpException.
 double getDouble(java.lang.String param, double defaultVal)
          Get double - if not found returns the default value.
 int getInt(java.lang.String param)
          Get integer - if not found throws FtpException.
 int getInt(java.lang.String param, int defaultVal)
          Get integer - if not found returns the default value.
 java.util.Iterator<java.lang.String> getKeys()
          Get the configuration keys.
 long getLong(java.lang.String param)
          Get long - if not found throws FtpException.
 long getLong(java.lang.String param, long defaultVal)
          Get long - if not found returns the default value.
 java.lang.String getString(java.lang.String param)
          Get string - if not found throws FtpException.
 java.lang.String getString(java.lang.String param, java.lang.String defaultVal)
          Get string - if not found returns the default value.
 boolean isEmpty()
          Is it an empty configuration?
 Configuration subset(java.lang.String param)
          Get configuration subset.
 

Method Detail

isEmpty

boolean isEmpty()
Is it an empty configuration?


getString

java.lang.String getString(java.lang.String param)
                           throws FtpException
Get string - if not found throws FtpException.

Throws:
FtpException

getString

java.lang.String getString(java.lang.String param,
                           java.lang.String defaultVal)
Get string - if not found returns the default value.


getInt

int getInt(java.lang.String param)
           throws FtpException
Get integer - if not found throws FtpException.

Throws:
FtpException

getInt

int getInt(java.lang.String param,
           int defaultVal)
Get integer - if not found returns the default value.


getLong

long getLong(java.lang.String param)
             throws FtpException
Get long - if not found throws FtpException.

Throws:
FtpException

getLong

long getLong(java.lang.String param,
             long defaultVal)
Get long - if not found returns the default value.


getBoolean

boolean getBoolean(java.lang.String param)
                   throws FtpException
Get boolean - if not found throws FtpException.

Throws:
FtpException

getBoolean

boolean getBoolean(java.lang.String param,
                   boolean defaultVal)
Get boolean - if not found returns the default value.


getDouble

double getDouble(java.lang.String param)
                 throws FtpException
Get double - if not found throws FtpException.

Throws:
FtpException

getDouble

double getDouble(java.lang.String param,
                 double defaultVal)
Get double - if not found returns the default value.


subset

Configuration subset(java.lang.String param)
Get configuration subset. The return value will never be null.


getKeys

java.util.Iterator<java.lang.String> getKeys()
Get the configuration keys. The order of the keys is not guaranteed to be the same as that of the input.



Copyright © 2003-2008 The Apache Software Foundation. All Rights Reserved.