/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

package org.openoffice.xmerge.merger;

import org.w3c.dom.Node;

/**
 * This is an interface for a {@link org.openoffice.xmerge.merger.MergeAlgorithm
 * MergeAlgorithm} to merge two {@code Node} objects.
 *
 * <p>It is an interface so that different merge algorithms may be plugged-in.</p>
 */
public interface NodeMergeAlgorithm {

    /**
     * This method is used to merge two given {@code Node} objects.
     *
     * <p>Note:  the original {@code Node} may be modified.</p>
     *
     * @param  originalNode  The original {@code Node}.
     * @param  modifyNode    The {@code Node} to be merged.  It may be modified.
     */
    void merge(Node originalNode, Node modifyNode);
}