View Javadoc

1   /*
2    * Copyright 2005 The Apache Software Foundation
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.commons.net.ftp;
17  
18  
19  /**
20   * This interface adds the aspect of configurability by means of
21   * a supplied FTPClientConfig object to other classes in the
22   * system, especially listing parsers.
23   */
24  public interface Configurable {
25  
26  	/**
27  	 * @param config the object containing the configuration data
28  	 * @return the object being configured after the configuration
29  	 * @throws IllegalArgumentException if the elements of the 
30  	 * <code>config</code> are somehow inadequate to configure the
31  	 * Configurable object.
32  	 */
33  	public void configure(
34  			FTPClientConfig config);	
35  }