Lines 7-13
Link Here
|
7 |
* |
7 |
* |
8 |
* Contributors: |
8 |
* Contributors: |
9 |
* IBM Corporation - initial API and implementation |
9 |
* IBM Corporation - initial API and implementation |
10 |
* Francis Lynch (Wind River) - [301563] Save and load tree snapshots |
10 |
* Francis Lynch (Wind River) - added loadSnapshot/saveSnapshot |
11 |
*******************************************************************************/ |
11 |
*******************************************************************************/ |
12 |
package org.eclipse.core.resources; |
12 |
package org.eclipse.core.resources; |
13 |
|
13 |
|
Lines 45-52
Link Here
|
45 |
*/ |
45 |
*/ |
46 |
public interface IProject extends IContainer, IAdaptable { |
46 |
public interface IProject extends IContainer, IAdaptable { |
47 |
/** |
47 |
/** |
48 |
* Option constant (value 1) indicating that a snapshot to be |
48 |
* Option constant (value 1) indicating that the snapshot to be |
49 |
* loaded or saved contains a resource tree (refresh information). |
49 |
* loaded or saved contains refresh information. |
50 |
* @see #loadSnapshot(int, URI, IProgressMonitor) |
50 |
* @see #loadSnapshot(int, URI, IProgressMonitor) |
51 |
* @see #saveSnapshot(int, URI, IProgressMonitor) |
51 |
* @see #saveSnapshot(int, URI, IProgressMonitor) |
52 |
* @since 3.6 |
52 |
* @since 3.6 |
Lines 585-600
Link Here
|
585 |
* Must be called after the project has been created, but before it is |
585 |
* Must be called after the project has been created, but before it is |
586 |
* opened. The options constant controls what kind of snapshot information |
586 |
* opened. The options constant controls what kind of snapshot information |
587 |
* to load. Valid option values include:<ul> |
587 |
* to load. Valid option values include:<ul> |
588 |
* <li>@link{IProject#SNAPSHOT_TREE} - load resource tree (refresh info) |
588 |
* <li>@link{IProject#SNAPSHOT_REFRESH} - snapshot refresh info |
589 |
* </ul> |
589 |
* </ul> |
590 |
* |
590 |
* |
591 |
* @param options kind of snapshot information to load |
591 |
* @param options kind of snapshot information to load |
592 |
* @param snapshotLocation URI to load from |
592 |
* @param snapshotLocation URI for the snapshot information |
593 |
* @param monitor a progress monitor, or <code>null</code> if progress |
593 |
* @param monitor a progress monitor, or <code>null</code> if progress |
594 |
* reporting is not desired |
594 |
* reporting is not desired |
595 |
* @exception CoreException if this method fails. Reasons include: |
595 |
* @exception CoreException if this method fails. Reasons include: |
596 |
* <ul> |
596 |
* <ul> |
597 |
* <li> The snapshot was not found at the specified URI.</li> |
597 |
* <li> The snapshot information was not found at the specified URI.</li> |
598 |
* </ul> |
598 |
* </ul> |
599 |
* @exception OperationCanceledException if the operation is canceled. |
599 |
* @exception OperationCanceledException if the operation is canceled. |
600 |
* @see #saveSnapshot(int, URI, IProgressMonitor) |
600 |
* @see #saveSnapshot(int, URI, IProgressMonitor) |
Lines 661-670
Link Here
|
661 |
* <ul> |
661 |
* <ul> |
662 |
* <li>If a {@link #loadSnapshot(int, URI, IProgressMonitor)} call has been made |
662 |
* <li>If a {@link #loadSnapshot(int, URI, IProgressMonitor)} call has been made |
663 |
* before the open, resources are restored from that file (a file written by |
663 |
* before the open, resources are restored from that file (a file written by |
664 |
* {@link #saveSnapshot(int, URI, IProgressMonitor)}). When the snapshot includes |
664 |
* {@link #saveSnapshot(int, URI, IProgressMonitor)}). |
665 |
* resource tree information and can be loaded without error, no refresh is initiated, |
665 |
* <li>When the {@link IResource#BACKGROUND_REFRESH} flag is specified, |
666 |
* so the project's resource tree will match what the snapshot provides. |
|
|
667 |
* <li>Otherwise, when the {@link IResource#BACKGROUND_REFRESH} flag is specified, |
668 |
* resources on disk will be added to the project in the background after |
666 |
* resources on disk will be added to the project in the background after |
669 |
* this method returns. Child resources of the project may not be available |
667 |
* this method returns. Child resources of the project may not be available |
670 |
* until this background refresh completes. |
668 |
* until this background refresh completes. |
Lines 735-745
Link Here
|
735 |
* Writes a snapshot of project meta-data into the given location URI. |
733 |
* Writes a snapshot of project meta-data into the given location URI. |
736 |
* The options constant controls what kind of snapshot information to |
734 |
* The options constant controls what kind of snapshot information to |
737 |
* write. Valid option values include:<ul> |
735 |
* write. Valid option values include:<ul> |
738 |
* <li>@link{IProject#SNAPSHOT_TREE} - save resource tree (refresh info) |
736 |
* <li>@link{IProject#SNAPSHOT_REFRESH} - snapshot refresh info |
739 |
* </ul> |
737 |
* </ul> |
740 |
* |
738 |
* |
741 |
* @param options kind of snapshot information to save |
739 |
* @param options kind of snapshot information to save |
742 |
* @param snapshotLocation URI for saving the snapshot to |
740 |
* @param snapshotLocation URI for the snapshot information |
743 |
* @param monitor a progress monitor, or <code>null</code> if progress |
741 |
* @param monitor a progress monitor, or <code>null</code> if progress |
744 |
* reporting is not desired |
742 |
* reporting is not desired |
745 |
* @exception CoreException if this method fails. Reasons include: |
743 |
* @exception CoreException if this method fails. Reasons include: |
Lines 917-920
Link Here
|
917 |
* @since 3.6 |
915 |
* @since 3.6 |
918 |
*/ |
916 |
*/ |
919 |
public IPathVariableManager getPathVariableManager(); |
917 |
public IPathVariableManager getPathVariableManager(); |
|
|
918 |
|
920 |
} |
919 |
} |