View Javadoc

1   /*
2    * #%L
3    * Native ARchive plugin for Maven
4    * %%
5    * Copyright (C) 2002 - 2014 NAR Maven Plugin developers.
6    * %%
7    * Licensed under the Apache License, Version 2.0 (the "License");
8    * you may not use this file except in compliance with the License.
9    * You may obtain a copy of the License at
10   * 
11   * http://www.apache.org/licenses/LICENSE-2.0
12   * 
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   * #L%
19   */
20  package com.github.maven_nar.cpptasks.ide;
21  
22  import java.io.File;
23  import java.io.IOException;
24  import java.util.List;
25  import java.util.Map;
26  
27  import org.xml.sax.SAXException;
28  
29  import com.github.maven_nar.cpptasks.CCTask;
30  import com.github.maven_nar.cpptasks.TargetInfo;
31  
32  /**
33   * Project writer interface.
34   *
35   * @author curta
36   *
37   */
38  public interface ProjectWriter {
39    /**
40     * Write project definition file.
41     * 
42     * @param baseName
43     *          File name base, writer may append appropriate extension
44     * @param task
45     *          task
46     * @param projectDef
47     *          project element
48     * @param files
49     *          source and header files
50     * @param targets
51     *          compilation targets
52     * @param linkTarget
53     *          link target
54     * @throws IOException
55     *           if I/O error is encountered
56     * @throws SAXException
57     *           if I/O error during XML serialization
58     */
59    void writeProject(final File baseName, final CCTask task, final ProjectDef projectDef, final List<File> files,
60        final Map<String, TargetInfo> targets, final TargetInfo linkTarget) throws IOException, SAXException;
61  }