diff options
Diffstat (limited to 'target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/interfaces/nodes/ILocatorModel.java')
| -rw-r--r-- | target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/interfaces/nodes/ILocatorModel.java | 158 |
1 files changed, 0 insertions, 158 deletions
diff --git a/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/interfaces/nodes/ILocatorModel.java b/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/interfaces/nodes/ILocatorModel.java deleted file mode 100644 index 7c89b9d54..000000000 --- a/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/interfaces/nodes/ILocatorModel.java +++ /dev/null @@ -1,158 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2011, 2012 Wind River Systems, Inc. and others. All rights reserved. - * This program and the accompanying materials are made available under the terms - * of the Eclipse Public License v1.0 which accompanies this distribution, and is - * available at http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * Wind River Systems - initial API and implementation - *******************************************************************************/ -package org.eclipse.tcf.te.tcf.locator.interfaces.nodes; - -import java.util.List; - -import org.eclipse.core.runtime.IAdaptable; -import org.eclipse.tcf.protocol.IPeer; -import org.eclipse.tcf.services.ILocator; -import org.eclipse.tcf.te.tcf.locator.interfaces.IModelListener; -import org.eclipse.tcf.te.tcf.locator.interfaces.IScanner; -import org.eclipse.tcf.te.tcf.locator.interfaces.services.ILocatorModelService; - - -/** - * The locator model is an extension to the TCF locator service. The - * model allows to store additional properties for each peer, keep - * track of peers from different origins. - * <p> - * <b>Note:</b> Updates to the locator model, and the locator model - * children needs to be performed in the TCF dispatch thread. The - * locator model and all child model nodes do assert this core - * assumption. To maintain consistency, and to avoid any performance - * overhead for thread synchronization, the model read access must - * happen in the TCF dispatch thread as well. - * - * @see ILocator - */ -public interface ILocatorModel extends IAdaptable { - - /** - * Adds the specified listener to the list of model listener. - * If the same listener has been added before, the listener will - * not be added again. - * - * @param listener The listener. Must not be <code>null</code>. - */ - public void addListener(IModelListener listener); - - /** - * Removes the specified listener from the list of model listener. - * - * @param listener The listener. Must not be <code>null</code>. - */ - public void removeListener(IModelListener listener); - - /** - * Returns the list of registered model listeners. - * - * @return The list of registered model listeners or an empty list. - */ - public IModelListener[] getListener(); - - /** - * Dispose the locator model instance. - */ - public void dispose(); - - /** - * Returns if or if not the locator model instance is disposed. - * - * @return <code>True</code> if the locator model instance is disposed, <code>false/code> otherwise. - */ - public boolean isDisposed(); - - /** - * Returns the list of known peers. - * - * @return The list of known peers or an empty list. - */ - public IPeerModel[] getPeers(); - - /** - * Returns an unmodifiable list of known children for the given parent peer. - * - * @param parentPeerID The parent peer id. Must not be <code>null</code>. - * @return The child list. - */ - public List<IPeerModel> getChildren(String parentPeerID); - - /** - * Sets the list of known children for the given parent peer. - * - * @param parentPeerID The parent peer id. Must not be <code>null</code>. - * @param children The list of children or <code>null</code> to remove the parent peer. - */ - public void setChildren(String parentPeerID, List<IPeerModel> children); - - /** - * Returns the scanner instance being associated with the - * locator model. - * - * @return The scanner instance. - */ - public IScanner getScanner(); - - /** - * Starts the scanner. - * - * @param delay The delay in millisecond before the scanning starts. - * @param schedule The time in millisecond between the scanner runs. - */ - public void startScanner(long delay, long schedule); - - /** - * Stops the scanner. - */ - public void stopScanner(); - - /** - * Returns the locator model service, implementing at least the specified - * service interface. - * - * @param serviceInterface The service interface class. Must not be <code>null</code>. - * @return The service instance implementing the specified service interface, or <code>null</code>. - */ - public <V extends ILocatorModelService> V getService(Class<V> serviceInterface); - - /** - * Validate the given peer. - * <p> - * If the peer is for local host, than only the peer using the loopback address is valid. - * - * @param peer The peer. Must not be <code>null</code>. - * @return The peer if the peer is valid, or <code>null</code> if not. - */ - public IPeer validatePeer(IPeer peer); - - /** - * Validate the given peer model if or if not it can be added to the locator model as new peer - * node. - * - * @param node The peer model. Must not be <code>null</code>. - * @return The peer node if it allowed add it to the model, or <code>null</code> if not. - */ - public IPeerModel validatePeerNodeForAdd(IPeerModel node); - - /** - * Validate the given child peer model node if or if not it can be added to the locator model - * as new child peer node for the associated parent peer model node. - * <p> - * <b>Note:</b> The parent peer node is determined by calling {@link IPeerModel#getParentNode()}. - * The call has to return a non-null value, otherwise {@link #validateChildPeerNodeForAdd(IPeerModel)} - * will do nothing. - * - * @param node The peer model. Must not be <code>null</code>. - * @return The peer node if it allowed add it to the model, or <code>null</code> if not. - */ - public IPeerModel validateChildPeerNodeForAdd(IPeerModel node); - -} |