blob: ee8ad4b940a7c3738339973ea6a322acff04e7e1 (
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.team.core.mapping;
import org.eclipse.core.resources.mapping.*;
import org.eclipse.team.core.mapping.provider.ScopeGenerator;
/**
* Interface which defines the protocol for translating a set of
* <code>ResourceMapping</code> objects representing a view selection into the
* complete set of resources to be operated on.
* <p>
* This interface is not intended to be implemented by clients. Instead, clients should
* use a {@link ScopeGenerator} to generate a resource mapping scope from
* a set of input resource mappings.
*
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is a guarantee neither that this API will
* work nor that it will remain the same. Please do not use this API without
* consulting with the Platform/Team team.
* </p>
*
* @see org.eclipse.core.resources.mapping.ResourceMapping
* @see ScopeGenerator
*
* @since 3.2
*/
public interface IResourceMappingScope extends ISynchronizationScope {
/**
* Return the array of mappings that acted as the input to the scope builder
* that was used to build this scope. This set usually come from a view
* selection but could come from another source. In most cases, clients will
* want to call the {@link #getMappings()} method instead of this one as it
* returns the complete set of mappings to be operated on.
*
* @return the set of mappings that acted as the input to the scope builder
* that was used to build this scope
*/
public ResourceMapping[] getInputMappings();
/**
* Return an array of all of the mappings to be operated on. The returned
* mappings were included in the operation during the scope building
* process. The returned mappings may be the same as the input mappings but
* may also be a super set. Clients can call the
* {@link #hasAdditionalMappings()} method to determine if the two sets are
* the same or not.
*
* @return an array of all of the mappings to be operated on.
*/
public ResourceMapping[] getMappings();
/**
* Return an array of traversals that cover the resource mappings to be
* operated on as returned by the {@link #getMappings()} method. The
* traversals were calculated during the scope building process and cached
* with the scope.
*
* @return the complete set of mappings to be operated on
*/
public ResourceTraversal[] getTraversals();
/**
* Return an array of traversals that cover the given resource mapping to be
* operated on. The traversals were calculated during the scope building
* process and cached with the scope.
*
* @param mapping a resource mapping being operated on
* @return the traversals that cover the given resource mapping (or
* <code>null</code> if the mapping is not contained in the input)
*/
public ResourceTraversal[] getTraversals(ResourceMapping mapping);
/**
* Return whether the scope has additional mappings added to the input
* mappings during the scope building process.
*
* @return whether the input has additional mappings added to the seed
* mappings
*/
public boolean hasAdditionalMappings();
/**
* Return whether the scope has additional resources added due to additional
* resource mappings.
*
* @return whether the input has additional resources added due to
* additional resource mappings
*/
public boolean hasAdditonalResources();
/**
* Return all the model providers that have mappings in this scope.
*
* @return all the model providers that have mappings in this scope
*/
public ModelProvider[] getModelProviders();
/**
* Return all the mappings to be operated on for the given model provider
* id.
*
* @param modelProviderId the id of the model provider
* @return all the mappings for the given model provider id
*/
public ResourceMapping[] getMappings(String modelProviderId);
/**
* Return the resource mapping in the scope associated with the given model
* object or <code>null</code> if there isn't one. This method has no knowledge
* of hierarchical models so it only matches directly against the mappings
* that are contained in the scope.
* @param modelObject the model object
* @return the mapping for the model object that is contained in this scope
*/
public ResourceMapping getMapping(Object modelObject);
}
|
