View Javadoc

1   /*
2   Karma core - Core of the Karma application
3   Copyright (C) 2004  Toolforge <www.toolforge.nl>
4   
5   This library is free software; you can redistribute it and/or
6   modify it under the terms of the GNU Lesser General Public
7   License as published by the Free Software Foundation; either
8   version 2.1 of the License, or (at your option) any later version.
9   
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  Lesser General Public License for more details.
14  
15  You should have received a copy of the GNU Lesser General Public
16  License along with this library; if not, write to the Free Software
17  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19  package nl.toolforge.karma.core.module.template;
20  
21  import java.io.File;
22  import java.io.IOException;
23  
24  
25  /***
26   * <p>Layout for a module. A new module can be initialized with new files and directories. Implementations of this
27   * class define those files and directories.
28   *
29   * @author D.A. Smedes
30   * @version $Id: ModuleLayoutTemplate.java,v 1.1 2004/11/10 22:25:11 hippe Exp $
31   */
32  public interface ModuleLayoutTemplate {
33  
34    public FileTemplate[] getFileElements();
35  
36    public String[] getDirectoryElements();
37  
38    /***
39     * Creates a templates' files and directories.
40     * 
41     * @param baseDir
42     * @throws IOException
43     */
44    public void createLayout(File baseDir) throws IOException;
45  
46  }