1 package org.codehaus.plexus.metadata.merge;
2
3 /*
4 * The MIT License
5 *
6 * Copyright (c) 2006, The Codehaus
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy of
9 * this software and associated documentation files (the "Software"), to deal in
10 * the Software without restriction, including without limitation the rights to
11 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12 * of the Software, and to permit persons to whom the Software is furnished to do
13 * so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in all
16 * copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
27 import java.io.File;
28 import java.io.IOException;
29 import java.util.List;
30
31 import org.jdom2.Document;
32
33 /**
34 * @author <a href='mailto:rahul.thakur.xdev@gmail.com'>Rahul Thakur</a>
35 */
36 public interface Merger {
37 String ROLE = Merger.class.getName();
38
39 /**
40 * Merge with the recessive document.
41 *
42 * @param dDocument the dominant document.
43 * @param rDocument the recessive document.
44 * @return the merged {@link Document} instance.
45 *
46 * @throws MergeException if there was an error in merge.
47 */
48 Document merge(Document dDocument, Document rDocument) throws MergeException;
49
50 /**
51 * Allows writing out a merged JDom Document to the specified file.
52 *
53 * @param mergedDocument the merged {@link Document} instance.
54 * @param file File to write the merged contents to.
55 * @throws IOException if there was an error while writing merged contents to the specified file.
56 */
57 void writeMergedDocument(Document mergedDocument, File file) throws IOException;
58
59 void mergeDescriptors(File outputDescriptor, List<File> descriptors) throws IOException;
60 }