ISynchronizeScope


1   /*******************************************************************************
2    * Copyright (c) 2000, 2006 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.team.ui.synchronize;
12  
13  import org.eclipse.core.resources.IResource;
14  import org.eclipse.jface.util.IPropertyChangeListener;
15  
16  /**
17   * A synchronize scope defines the set of resources involved in a synchronization.
18   * Instance of this interface are used to scope the resources of a created {@link SubscriberParticipant}.
19   * <p>
20   * This interface is not intended to be implemented by clients
21   * </p>
22   * @see SubscriberParticipant
23   * @since 3.0
24   */
25  public interface ISynchronizeScope {
26      
27      /**
28       * Property used to indicate when the roots of the scope have changed.
29       */
30      public static final String   ROOTS = "prop_roots"; //$NON-NLS-1$
31      
32      /**
33       * Property used to indicate when the name of the scope has changed.
34       * @since 3.1
35       */
36      public static final String   NAME = "prop_name"; //$NON-NLS-1$
37      
38      /**
39       * Return the name of the scope
40       * 
41       * @return the name of the scope
42       */
43      public String   getName();
44      
45      /**
46       * Return the root resources that define this scope. A return value
47       * of <code>null</code> indicates that the participant should use
48       * its default set of resources.
49       * 
50       * @return the root resources or <code>null</code>
51       */
52      public IResource[] getRoots();
53      
54      /**
55       * Add a property change listener that will get invoked when a
56       * property of the receiver changes.
57       * 
58       * @param listener
59       */
60      public void addPropertyChangeListener(IPropertyChangeListener listener);
61      
62      /**
63       * Remove a property change listener. Removing an unregistered listener
64       * has no effect.
65       * 
66       * @param listener
67       */
68      public void removePropertyChangeListener(IPropertyChangeListener listener);
69      
70      /**
71       * Dispose of the scope when it is no longer needed.
72       */
73      public void dispose();
74  }
75
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags