01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * If you wish your version of this file to be governed by only the CDDL
25: * or only the GPL Version 2, indicate your decision by adding
26: * "[Contributor] elects to include this software in this distribution
27: * under the [CDDL or GPL Version 2] license." If you do not indicate a
28: * single choice of license, a recipient has the option to distribute
29: * your version of this file under either the CDDL, the GPL Version 2 or
30: * to extend the choice of license to its licensees as provided above.
31: * However, if you add GPL Version 2 code and therefore, elected the GPL
32: * Version 2 license, then the option applies only if the new code is
33: * made subject to such option by the copyright holder.
34: *
35: * Contributor(s):
36: *
37: * Portions Copyrighted 2007 Sun Microsystems, Inc.
38: */
39:
40: package org.netbeans.spi.server;
41:
42: import java.util.List;
43: import javax.swing.event.ChangeListener;
44: import org.netbeans.api.server.ServerInstance;
45:
46: /**
47: * Provides the known server instances. Any registered listener must be
48: * notified when instance is added or removed during the life of the provider.
49: * <p>
50: * In order to register your provider you have to register it in filesystem
51: * in folder <code>Servers</code>.
52: * <p>
53: * Note you can use {@link org.openide.util.ChangeSupport} for implementation
54: * of listener logic.
55: *
56: * @author Petr Hejl
57: */
58: public interface ServerInstanceProvider {
59:
60: /**
61: * Returns the list of known server instances.
62: *
63: * @return the list of known server instances
64: */
65: List<ServerInstance> getInstances();
66:
67: /**
68: * Adds a change listener to the provider. The listener must be notified
69: * any time instance is added or removed.
70: *
71: * @param listener listener to add, <code>null</code> is allowed (but it si noop then)
72: */
73: void addChangeListener(ChangeListener listener);
74:
75: /**
76: * Removes the previously added listener. No more events will be fired on
77: * the listener.
78: *
79: * @param listener listener to remove, <code>null</code> is allowed (but it si noop then)
80: */
81: void removeChangeListener(ChangeListener listener);
82:
83: }
|