ServerInstanceProvider.java :  » IDE-Netbeans » server » org » netbeans » spi » server » Java Open Source

Java Open Source » IDE Netbeans » server 
server » org » netbeans » spi » server » ServerInstanceProvider.java
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2007 Sun Microsystems, Inc.
 */

package org.netbeans.spi.server;

import java.util.List;
import javax.swing.event.ChangeListener;
import org.netbeans.api.server.ServerInstance;

/**
 * Provides the known server instances. Any registered listener must be
 * notified when instance is added or removed during the life of the provider.
 * <p>
 * In order to register your provider you have to register it in filesystem
 * in folder <code>Servers</code>.
 * <p>
 * Note you can use {@link org.openide.util.ChangeSupport} for implementation
 * of listener logic.
 *
 * @author Petr Hejl
 */
public interface ServerInstanceProvider {

    /**
     * Returns the list of known server instances.
     *
     * @return the list of known server instances
     */
    List<ServerInstance> getInstances();

    /**
     * Adds a change listener to the provider. The listener must be notified
     * any time instance is added or removed.
     *
     * @param listener listener to add, <code>null</code> is allowed (but it si noop then)
     */
    void addChangeListener(ChangeListener listener);

    /**
     * Removes the previously added listener. No more events will be fired on
     * the listener.
     *
     * @param listener listener to remove, <code>null</code> is allowed (but it si noop then)
     */
    void removeChangeListener(ChangeListener listener);

}
java2s.com  | Contact Us | Privacy Policy
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.