/*
 * Copyright 2012-2017 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.vm.heap.analysis.client.core;

import java.util.List;

import com.redhat.thermostat.client.core.views.BasicView;
import com.redhat.thermostat.client.core.views.UIComponent;
import com.redhat.thermostat.common.ActionListener;
import com.redhat.thermostat.common.ActionNotifier;
import com.redhat.thermostat.shared.locale.LocalizedString;
import com.redhat.thermostat.vm.heap.analysis.client.core.chart.OverviewChart;
import com.redhat.thermostat.vm.heap.analysis.common.DumpFile;
import com.redhat.thermostat.vm.heap.analysis.common.HeapDump;

public abstract class HeapView extends BasicView implements UIComponent {

    public enum HeapDumperAction {
        DUMP_REQUESTED,
        ANALYSE,
        REQUEST_EXPORT,
        SAVE_HEAP_DUMP,
        REQUEST_ABORTED,
        REQUEST_DISPLAY_DUMP_LIST,
    }

    public enum DumpDisabledReason {
        DUMP_IN_PROGRESS,
        PROCESS_DEAD,
    }

    protected final ActionNotifier<HeapDumperAction> heapDumperNotifier;
    protected HeapView() {
        heapDumperNotifier = new ActionNotifier<HeapDumperAction>(this);
    }
    
    public void addDumperListener(ActionListener<HeapDumperAction> listener) {
        heapDumperNotifier.addActionListener(listener);
    }
    
    public void removeDumperListener(ActionListener<HeapDumperAction> listener) {
        heapDumperNotifier.removeActionListener(listener);
    }

    public abstract void updateUsedAndCapacity(String used, String capacity);
    /** View updates automatically based on the model */
    public abstract void setModel(OverviewChart model);

    public abstract void enableHeapDumping();
    public abstract void disableHeapDumping(DumpDisabledReason reason);

    public abstract void addHeapDump(HeapDump dump);
    public abstract void updateHeapDumpList(List<HeapDump> heapDumps);
    public abstract void clearHeapDumpList();

    public abstract void openDumpView();
    public abstract void setChildView(BasicView childView);
    public abstract void setActiveDump(HeapDump dump);
    public abstract void notifyHeapDumpComplete();

    public abstract void displayWarning(LocalizedString string);

    public abstract void openDumpListView(HeapDumpListView childView);

    public abstract void openExportDialog(DumpFile heapdDump);
}