ISynchronizeParticipantDescriptor


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.jface.resource.ImageDescriptor;
14  
15  /**
16   * A participant descriptor contains the content of the 
17   * <code>synchronizeParticipants</code> extension section for 
18   * for a registered participant type in the declaring plug-in's 
19   * manifest (<code>plugin.xml</code>) file.
20   * <p>
21   * Clients are not intended to implement this interface.
22   * </p>
23   * @see ISynchronizeManager#getParticipantDescriptor(String)
24   * @since 3.0
25   */
26  public interface ISynchronizeParticipantDescriptor {
27      /**
28       * Returns the name of this participant. This can be shown to the user.
29       * 
30       * @return the name of this participant. This can be shown to the user.
31       */
32      public String   getName();
33      
34      /**
35       * Returns a string describing this participant type.
36       * 
37       * @return a string describing this participant type.
38       */
39      public String   getDescription();
40      
41      /**
42       * Returns the unique id that identifies this participant type.
43       * 
44       * @return the unique id that identifies this participant type.
45       */
46      public String   getId();
47  
48      /**
49       * Returns the image descriptor for this participant type.
50       * 
51       * @return the image descriptor for this participant type.
52       */
53      public ImageDescriptor getImageDescriptor();
54      
55      /**
56       * Returns if this participant can be persisted between sessions.
57       * 
58       * @return <code>true</code> if this participant can be persisted between sessions
59       * and false otherwise.
60       */
61      public boolean isPersistent();
62  }
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags