/*
 *  Copyright (c) 2007, 2011, 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.heapdump;

import org.graalvm.visualvm.core.datasource.DataSource;
import org.graalvm.visualvm.core.snapshot.Snapshot;
import org.graalvm.visualvm.core.snapshot.SnapshotsSupport;
import java.io.File;
import org.graalvm.visualvm.core.datasupport.Utils;
import org.openide.util.NbBundle;

/**
 * Abstract implementation of HeapDump.
 * Each heapdump is defined by a heapdump file.
 *
 * @author Jiri Sedlacek
 */
public abstract class HeapDump extends Snapshot {
    
    private static final String HWCACHE_EXT = ".hwcache"; // NOI18N
    
    /**
     * Creates new instance of HeapDump with the data stored in a file.
     * 
     * @param file file where heap dump is saved.
     */
    public HeapDump(File file) {
        this(file, null);
    }
    
    /**
     * Creates new instance of HeapDump with the data stored in a file and defined master.
     * 
     * @param file file where heap dump is saved,
     * @param master DataSource in whose window the heap dump will be displayed.
     */
    public HeapDump(File file, DataSource master) {
        super(file, HeapDumpSupport.getInstance().getCategory(), master);
    }
    
    public boolean supportsSaveAs() {
        return getFile() != null;
    }
    
    public void saveAs() {
        SnapshotsSupport.getInstance().saveAs(this, NbBundle.getMessage(HeapDump.class, "LBL_Save_Heap_Dump_As"));  // NOI18N
    }
    
    protected void remove() {
        final File f = getFile();
        
        // #GH-111: delete the corresponding .hwcache directory
        if (f != null) Utils.FILE_QUEUE.post(new Runnable() {
            public void run() {
                File ff = new File(f.getParent(), f.getName() + HWCACHE_EXT);
                if (ff.isDirectory()) Utils.delete(ff, true);
            }
        });
        
        super.remove();
    }

}
