PageRenderTime 306ms CodeModel.GetById 303ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

/jEdit/tags/jedit-4-5-pre1/org/gjt/sp/jedit/bsh/NameSource.java

#
Java | 64 lines | 9 code | 3 blank | 52 comment | 0 complexity | 8c025ca1e887287e739b60bd5fa77e29 MD5 | raw file
 1/*****************************************************************************
 2 *                                                                           *
 3 *  This file is part of the BeanShell Java Scripting distribution.          *
 4 *  Documentation and updates may be found at http://www.beanshell.org/      *
 5 *                                                                           *
 6 *  Sun Public License Notice:                                               *
 7 *                                                                           *
 8 *  The contents of this file are subject to the Sun Public License Version  *
 9 *  1.0 (the "License"); you may not use this file except in compliance with *
10 *  the License. A copy of the License is available at http://www.sun.com    *
11 *                                                                           *
12 *  The Original Code is BeanShell. The Initial Developer of the Original    *
13 *  Code is Pat Niemeyer. Portions created by Pat Niemeyer are Copyright     *
14 *  (C) 2000.  All Rights Reserved.                                          *
15 *                                                                           *
16 *  GNU Public License Notice:                                               *
17 *                                                                           *
18 *  Alternatively, the contents of this file may be used under the terms of  *
19 *  the GNU Lesser General Public License (the "LGPL"), in which case the    *
20 *  provisions of LGPL are applicable instead of those above. If you wish to *
21 *  allow use of your version of this file only under the  terms of the LGPL *
22 *  and not to allow others to use your version of this file under the SPL,  *
23 *  indicate your decision by deleting the provisions above and replace      *
24 *  them with the notice and other provisions required by the LGPL.  If you  *
25 *  do not delete the provisions above, a recipient may use your version of  *
26 *  this file under either the SPL or the LGPL.                              *
27 *                                                                           *
28 *  Patrick Niemeyer (pat@pat.net)                                           *
29 *  Author of Learning Java, O'Reilly & Associates                           *
30 *  http://www.pat.net/~pat/                                                 *
31 *                                                                           *
32 *****************************************************************************/
33
34package org.gjt.sp.jedit.bsh;
35
36/**
37    This interface supports name completion, which is used primarily for
38    command line tools, etc.  It provides a flat source of "names" in a
39    space.  For example all of the classes in the classpath or all of the
40    variables in a namespace (or all of those).
41    <p>
42    NameSource is the lightest weight mechanism for sources which wish to
43    support name completion.  In the future it might be better for NameSpace
44    to implement NameCompletion directly in a more native and efficient
45    fasion.  However in general name competion is used for human interaction
46    and therefore does not require high performance.
47    <p>
48*/
49public interface NameSource
50{
51    public String [] getAllNames();
52    public void addNameSourceListener( NameSource.Listener listener );
53
54    public static interface Listener {
55        public void nameSourceChanged( NameSource src );
56        /**
57            Provide feedback on the progress of mapping a namespace
58            @param msg is an update about what's happening
59            @perc is an integer in the range 0-100 indicating percentage done
60        public void nameSourceMapping(
61            NameSource src, String msg, int perc );
62        */
63    }
64}