blob: 12aae5b1e28a759bcc366f10864eeb14e6f7b3c6 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.team.ui.synchronize;
import org.eclipse.jface.resource.ImageDescriptor;
/**
* A participant descriptor contains the content of the
* <code>synchronizeParticipants</code> extension section for
* for a registered participant type in the declaring plug-in's
* manifest (<code>plugin.xml</code>) file.
* <p>
* Clients are not intended to implement this interface.
* </p>
* @see ISynchronizeManager#getParticipantDescriptor(String)
* @since 3.0
*/
public interface ISynchronizeParticipantDescriptor {
/**
* Returns the name of this participant. This can be shown to the user.
*
* @return the name of this participant. This can be shown to the user.
*/
public String getName();
/**
* Returns a string describing this participant type.
*
* @return a string describing this participant type.
*/
public String getDescription();
/**
* Returns the unique id that identifies this participant type.
*
* @return the unique id that identifies this participant type.
*/
public String getId();
/**
* Returns the image descriptor for this participant type.
*
* @return the image descriptor for this participant type.
*/
public ImageDescriptor getImageDescriptor();
/**
* Returns <code>true</code> if the participant is static and
* <code>false</code> otherwise. Static participants are created
* automatically by the synchronize manager at startup whereas
* not static participants are created by client code and registered
* with the manager.
*
* @return <code>true</code> if the participant is static and
* <code>false</code> otherwise
*/
public boolean isStatic();
/**
* Returns if this participant supports a global refresh action.
*
* @return if this participant supports a global refresh action.
*/
public boolean doesSupportRefresh();
/**
* Does this type of participant allow multiple instances.
*
*/
public boolean doesAllowMultiple();
/**
* Can be persisted between sessions.
*
*/
public boolean isPersistent();
}
|