Class AbstractSnapshotParticipant
- java.lang.Object
-
- com.e1c.g5.v8.snapshot.participation.AbstractSnapshotParticipant
-
- All Implemented Interfaces:
ISnapshotParticipant
- Direct Known Subclasses:
StandardSnapshotParticipant
public abstract class AbstractSnapshotParticipant extends Object implements ISnapshotParticipant
Abstract snapshot participant for convenient implementation of custom snapshot participants.
-
-
Constructor Summary
Constructors Constructor Description AbstractSnapshotParticipant()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
contributeMetadata(org.eclipse.core.resources.IProject project, String entry, DataOutputStream output)
Requests the participant to contribute metadata for the previously configured metadata entry.void
restoreMetadata(org.eclipse.core.resources.IProject project, String entry, DataInputStream input)
Requests the participant to read metadata from snapshot.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.e1c.g5.v8.snapshot.participation.ISnapshotParticipant
configure, getFormatVersion
-
-
-
-
Method Detail
-
contributeMetadata
public void contributeMetadata(org.eclipse.core.resources.IProject project, String entry, DataOutputStream output)
Description copied from interface:ISnapshotParticipant
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()
.- Specified by:
contributeMetadata
in interfaceISnapshotParticipant
- 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
-
restoreMetadata
public void restoreMetadata(org.eclipse.core.resources.IProject project, String entry, DataInputStream input)
Description copied from interface:ISnapshotParticipant
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()
.- Specified by:
restoreMetadata
in interfaceISnapshotParticipant
- 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
-
-