Interface ISnapshotParticipant
-
- All Known Implementing Classes:
AbstractSnapshotParticipant
,EmptyParticipant
,StandardSnapshotParticipant
public interface ISnapshotParticipant
Snapshot participant. Implementations are intended to be used as extensions ofcom._1c.g5.v8.snapshot.participants
extension point.- See Also:
ISnapshotConfigurator
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
configure(org.eclipse.core.resources.IProject project, ISnapshotConfigurator configurator)
Requests the participant to configure snapshot.void
contributeMetadata(org.eclipse.core.resources.IProject project, String entry, DataOutputStream output)
Requests the participant to contribute metadata for the previously configured metadata entry.int
getFormatVersion()
Gets format version of the snapshot participant.void
restoreMetadata(org.eclipse.core.resources.IProject project, String entry, DataInputStream input)
Requests the participant to read metadata from snapshot.
-
-
-
Method Detail
-
configure
void configure(org.eclipse.core.resources.IProject project, ISnapshotConfigurator configurator)
Requests the participant to configure snapshot. Called some time before snapshot creation and restoration.- Parameters:
project
- the project for which snapshot is going to be created, cannot benull
configurator
- the configurator to configure snapshot, cannot benull
-
contributeMetadata
void contributeMetadata(org.eclipse.core.resources.IProject project, String entry, DataOutputStream output) throws IOException
Requests the participant to contribute metadata for the previously configured metadata entry.This method is called during snapshot creation once for each metadata entry, which was added by
ISnapshotConfigurator.addMetadataEntry(java.lang.String)
. The order of entries supplied to this method is not specified.Participants must not call
output.close()
.- Parameters:
project
- the project for which snapshot is being created, cannot benull
entry
- the metadata entry name, cannot benull
output
- the data output stream to write metadata, cannot benull
- Throws:
IOException
-
restoreMetadata
void restoreMetadata(org.eclipse.core.resources.IProject project, String entry, DataInputStream input) throws IOException
Requests the participant to read metadata from snapshot.This method is called during snapshot restoration once for each metadata entry, which was added to the snapshot by the same participant on creation. The order of entries supplied to this method is not specified.
Participants must not call
input.close()
.- Parameters:
project
- the project for which snapshot is being restored, cannot benull
entry
- the metadata entry name, cannot benull
input
- the data input stream to read metadata, cannot benull
- Throws:
IOException
-
getFormatVersion
int getFormatVersion()
Gets format version of the snapshot participant. Whenever the format version of a participant does not match the format version stored in a snapshot for this participant, the snapshot is considered invalid and cannot be restored.Snapshot participants are encouraged to smoothly migrate their data. The format version must be increased only if migration is impossible or too heavy.
- Returns:
- the format version of the participant
-
-