Interface ISnapshotConfigurator
-
public interface ISnapshotConfiguratorSnapshot configurator is used bysnapshot participantsto configure snapshot creation and restoration.- Restriction:
- This interface is not intended to be extended by clients.
- Restriction:
- This interface is not intended to be implemented by clients.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceISnapshotConfigurator.ISnapshotConfiguratorEntrySnapshot configurator entry.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddMetadataEntry(String name)Add snapshot metadata entry.ISnapshotConfigurator.ISnapshotConfiguratorEntryinclude(Path root)Include file or folder to snapshot for the given project.
-
-
-
Method Detail
-
addMetadataEntry
void addMetadataEntry(String name)
Add snapshot metadata entry. The corresponding snapshot participant will be asked to contribute metadata during snapshot creation withISnapshotParticipant.contributeMetadata(org.eclipse.core.resources.IProject, java.lang.String, java.io.OutputStream).- Parameters:
name- entry name, cannot benull- Throws:
IllegalStateException- if the same entry was already added
-
include
ISnapshotConfigurator.ISnapshotConfiguratorEntry include(Path root)
Include file or folder to snapshot for the given project.If
rootis a relative path, it will be resolved against the meta area location. Otherwise it is still required to point inside the meta area location.rootis not required to exist.- Parameters:
root- relative or absolute path to the file or folder in the meta area location, cannot benull- Returns:
- configurator entry to further configure snapshot creation under the location, never
null
-
-