blob: efba8d7ea544bd8fb45a8b63e74095df0987f952 (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2004 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.team.core.TeamException;
/**
* A reference is a light weight handle used by the {@link ISynchronizeManager}
* to manage registered participants. It is used to reference information
* about a particular participant instance without requiring the participant
* to be instantiated. Calling the {@link #getParticipant()} method will
* cause the participant to be instantiated.
* <p>
* Clients are not intended to implement this interface.
* </p>
* @see ISynchronizeManager
* @since 3.0
*/
public interface ISynchronizeParticipantReference {
/**
* Returns the id of the participant type referenced by this handle.
*
* @return the id of the participant type references by this handle.
*/
public String getId();
/**
* Returns the secondary id (e.g. instance id) of the participant type referenced
* by this handle or <code>null</code> if the participant doesn't support
* multiple instances.
*
* @return the secondary id of the participant type referenced
* by this handle or <code>null</code> if the participant doesn't support
* multiple instances.
*/
public String getSecondaryId();
/**
* Returns the fully qualified name of this participant reference. This includes the
* secondaryId if available. This can be displayed in the user interface to allow
* the user to distinguish between multiple instances of a participant.
*
* @return the fully qualified name of this participant reference
*/
public String getDisplayName();
/**
* Returns the participant referenced by this handle. This may trigger loading of the
* participant and and a result may be long running. The method may return <code>null</code>
* if the participant cannot be de-referenced.
*
* @return the participant referencesd by this handle.
*/
public ISynchronizeParticipant getParticipant() throws TeamException;
/**
* Returns the descriptor for this participant type.
*
* @return the descriptor for this participant type.
*/
public ISynchronizeParticipantDescriptor getDescriptor();
}
|
