001    /*****************************************************************************
002     *                                                                           *
003     *  This file is part of the BeanShell Java Scripting distribution.          *
004     *  Documentation and updates may be found at http://www.beanshell.org/      *
005     *                                                                           *
006     *  Sun Public License Notice:                                               *
007     *                                                                           *
008     *  The contents of this file are subject to the Sun Public License Version  *
009     *  1.0 (the "License"); you may not use this file except in compliance with *
010     *  the License. A copy of the License is available at http://www.sun.com    * 
011     *                                                                           *
012     *  The Original Code is BeanShell. The Initial Developer of the Original    *
013     *  Code is Pat Niemeyer. Portions created by Pat Niemeyer are Copyright     *
014     *  (C) 2000.  All Rights Reserved.                                          *
015     *                                                                           *
016     *  GNU Public License Notice:                                               *
017     *                                                                           *
018     *  Alternatively, the contents of this file may be used under the terms of  *
019     *  the GNU Lesser General Public License (the "LGPL"), in which case the    *
020     *  provisions of LGPL are applicable instead of those above. If you wish to *
021     *  allow use of your version of this file only under the  terms of the LGPL *
022     *  and not to allow others to use your version of this file under the SPL,  *
023     *  indicate your decision by deleting the provisions above and replace      *
024     *  them with the notice and other provisions required by the LGPL.  If you  *
025     *  do not delete the provisions above, a recipient may use your version of  *
026     *  this file under either the SPL or the LGPL.                              *
027     *                                                                           *
028     *  Patrick Niemeyer (pat@pat.net)                                           *
029     *  Author of Learning Java, O'Reilly & Associates                           *
030     *  http://www.pat.net/~pat/                                                 *
031     *                                                                           *
032     *****************************************************************************/
033    
034    package bsh;
035    import java.util.*;
036    
037    /**
038            This interface supports name completion, which is used primarily for 
039            command line tools, etc.  It provides a flat source of "names" in a 
040            space.  For example all of the classes in the classpath or all of the 
041            variables in a namespace (or all of those).
042            <p>
043            NameSource is the lightest weight mechanism for sources which wish to
044            support name completion.  In the future it might be better for NameSpace
045            to implement NameCompletion directly in a more native and efficient 
046            fasion.  However in general name competion is used for human interaction
047            and therefore does not require high performance.
048            <p>
049            @see bsh.util.NameCompletion
050            @see bsh.util.NameCompletionTable
051    */
052    public interface NameSource 
053    {
054            public String [] getAllNames();
055            public void addNameSourceListener( NameSource.Listener listener );
056    
057            public static interface Listener {
058                    public void nameSourceChanged( NameSource src );
059                    /**
060                            Provide feedback on the progress of mapping a namespace
061                            @param msg is an update about what's happening
062                            @perc is an integer in the range 0-100 indicating percentage done
063                    public void nameSourceMapping( 
064                            NameSource src, String msg, int perc );
065                    */
066            }
067    }