/*
 * Copyright (c) 1997, 2018, 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 org.graalvm.visualvm.lib.profiler.api;

import org.netbeans.api.progress.ProgressHandle;
import org.openide.util.Cancellable;

/**
 *
 * @author Jaroslav Bachorik
 */
public interface ProgressDisplayer {
    //~ Inner Interfaces ---------------------------------------------------------------------------------------------------------

    public static interface ProgressController extends Cancellable {
    }

    //~ Methods ------------------------------------------------------------------------------------------------------------------

    public void close();

    public ProgressDisplayer showProgress(String message);

    public ProgressDisplayer showProgress(String message, ProgressController controller);

    public ProgressDisplayer showProgress(String caption, String message, ProgressController controller);

    public static final ProgressDisplayer DEFAULT = new ProgressDisplayer() {
        ProgressHandle ph = null;

        public synchronized ProgressDisplayer showProgress(String message) {
            ph = ProgressHandle.createHandle(message);
            ph.start();
            return DEFAULT;
        }

        public synchronized ProgressDisplayer showProgress(String message, ProgressController controller) {
            ph = ProgressHandle.createHandle(message, controller);
            ph.start();
            return DEFAULT;
        }

        public synchronized ProgressDisplayer showProgress(String caption, String message, ProgressController controller) {
            ph = ProgressHandle.createHandle(message, controller);
            ph.start();
            return DEFAULT;
        }

        public synchronized void close() {
            if (ph != null) {
                ph.finish();
                ph = null;
            }
        }
    };

}
