/*

 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package jdk.internal.editor.spi;

import java.util.function.Consumer;

/**

 * Defines the provider of a built-in editor.

 */

public interface BuildInEditorProvider {

    /**

     * @return the rank of a provider, greater is better.

     */

    int rank();

    /**

     * Create a simple built-in editor.

     *

     * @param windowLabel the label string for the Edit Pad window, or null,

     * for default window label

     * @param initialText the source to load in the Edit Pad

     * @param saveHandler a handler for changed source (can be sent the full source)

     * @param errorHandler a handler for unexpected errors

     */

    void edit(String windowLabel, String initialText,

            Consumer<String> saveHandler, Consumer<String> errorHandler);

}