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
|
/*******************************************************************************
* Copyright (c) 2000, 2008 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.history;
import org.eclipse.core.filesystem.IFileStore;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.team.core.history.provider.FileHistoryProvider;
/**
* This is API to access individual file histories.
*
* @since 3.2
* @noimplement This interface is not intended to be implemented by clients.
* Clients can instead subclass {@link FileHistoryProvider}.
*
*/
public interface IFileHistoryProvider {
/**
* Constant flag used with
* {@link #getFileHistoryFor(IResource, int, IProgressMonitor)} to indicate
* no flags.
*/
public static final int NONE = 0;
/**
* Constant flag used with {@link #getFileHistoryFor(IResource, int, IProgressMonitor)}
* to indicate that only a single revision is desired.
*/
public static final int SINGLE_REVISION = 1;
/**
* Constant flag used with
* {@link #getFileHistoryFor(IResource, int, IProgressMonitor)} to indicate
* that the resulting history will be restricted to a single line-of-descent
* (e.g. a single branch). In this mode, the
* {@link IFileHistory#getContributors(IFileRevision)} and
* {@link IFileHistory#getTargets(IFileRevision)} should either return zero
* or one revision.
*/
public static final int SINGLE_LINE_OF_DESCENT = 2;
/**
* Returns the file history for the given in resource. If the flags contains
* {@link #SINGLE_REVISION} then only the revision corresponding to the base
* corresponding to the local resource is fetched. If the flags contains
* {@link #SINGLE_LINE_OF_DESCENT} the resulting history will be restricted
* to a single line-of-descent (e.g. a single branch). In this mode, the
* {@link IFileHistory#getContributors(IFileRevision)} and
* {@link IFileHistory#getTargets(IFileRevision)} should either return zero
* or one revision. If both flags are present, {@link #SINGLE_REVISION}
* should take precedence.
*
* @param resource
* the resource
* @param flags
* to indicate what revisions should be included in the history
* @param monitor
* a progress monitor
* @return the history of the file
*/
public abstract IFileHistory getFileHistoryFor(IResource resource, int flags, IProgressMonitor monitor);
/**
* Returns the file revision of the passed in resource or null if that file revision cannot be
* determined
*
* @param resource the resource
* @return the file revision belonging to the passed in resource or null
*/
public abstract IFileRevision getWorkspaceFileRevision(IResource resource);
/**
* Returns an {@link IFileHistory} for the specified {@link IFileStore}.
* @param store an IFileStore
* @param flags {@link #SINGLE_REVISION} or {@link #SINGLE_LINE_OF_DESCENT}
* @param monitor a progress monitor
* @return the history for the IFileStore
*/
public abstract IFileHistory getFileHistoryFor(IFileStore store, int flags, IProgressMonitor monitor);
}
|