/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.openfile.cli;

import java.io.File;

/**
 * Communication channel between CLI (classpath) code and rest of module.
 * Register an instance to default lookup.
 * @author Jesse Glick
 */
public interface Callback {
    
    /**
     * Open a file.
     * @param f the file to open
     * @param line a number number, starting at zero (-1 to ignore)
     * @param waiter if not null, notify the waiter when the file is closed
     *               (only applicable if open is successful)
     * @return true on success, false on failure
     */
    boolean open(File f, int line, Waiter waiter);
    
    /**
     * Double-callback to notify the CLI that a file has been opened and closed again.
     */
    interface Waiter {
        
        /**
         * The file has been closed again.
         */
        void done();
        
    }
    
}