001    /*
002     * Copyright 2005 The Apache Software Foundation
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *     http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.apache.commons.net.ftp;
017    
018    
019    /**
020     * This interface adds the aspect of configurability by means of
021     * a supplied FTPClientConfig object to other classes in the
022     * system, especially listing parsers.
023     */
024    public interface Configurable {
025    
026            /**
027             * @param config the object containing the configuration data
028             * @return the object being configured after the configuration
029             * @throws IllegalArgumentException if the elements of the 
030             * <code>config</code> are somehow inadequate to configure the
031             * Configurable object.
032             */
033            public void configure(
034                            FTPClientConfig config);        
035    }