org.netbeans.spi.diff.DiffControllerProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-modules-diff Show documentation
The newest version!
/*
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.netbeans.spi.diff;

import org.netbeans.api.diff.StreamSource;

import java.io.IOException;

/**
 * Provider for DiffControllerImpl implemetations. Providers should be registered in default lookup using {@link org.openide.util.lookup.ServiceProvider}. 
 * 
 * @author Maros Sandor
 */
public abstract class DiffControllerProvider {

    /**
     * Creates a Diff Controller for supplied left and right sources.
     * 
     * @param base defines content of the Base Diff pane
     * @param modified defines content of the Modified (possibly editable) Diff pane
     * @return DiffControllerImpl implementation of the DiffControllerImpl class
     * @throws java.io.IOException when initialization of the controlloer fails (invalid sources, etc)
     */
    public abstract DiffControllerImpl createDiffController(StreamSource base, StreamSource modified) throws IOException;

    /**
     * Creates a Diff Controller for supplied left and right sources.
     * It is up to the implementor to override this method and return a Diff Controller which is capable of providing enhanced UI.
     * Unless overriden, this will return the same Controller as {@link #createDiffController(org.netbeans.api.diff.StreamSource, org.netbeans.api.diff.StreamSource) } would do.
     *
     * @param base defines content of the Base Diff pane
     * @param modified defines content of the Modified (possibly editable) Diff pane
     * @return DiffControllerImpl implementation of the DiffControllerImpl class
     * @throws java.io.IOException when initialization of the controller fails (invalid sources, etc)
     * @since 1.27
     */
    public DiffControllerImpl createEnhancedDiffController(StreamSource base, StreamSource modified) throws IOException {
        return createDiffController(base, modified);
    }
}