View Javadoc

1   package org.molwind.util;
2   
3   /*
4    * This file is part of Molwind.
5    *
6    * Molwind is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation, either version 3 of the License, or
9    * (at your option) any later version.
10   *
11   * Molwind is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with Molwind. If not, see <http://www.gnu.org/licenses/>.
18   */
19  
20  /**
21   * Configurable tags objects to be configurable.
22   *
23   * @author <a href="mailto:oliver.karch@molwind.org">Oliver Karch</a>
24   * @version 1.0
25   */
26  public interface Configurable {
27  
28      /**
29       * Configures this object from a given configurator.
30       *
31       * @param config
32       *      the configurator
33       * @throws org.molwind.util.ConfigException
34       *      is thrown upon config error
35       */
36      void configure(Configurator config)
37      throws ConfigException;
38  
39  }