View Javadoc

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