Package com.e1c.g5.v8.snapshot.participant

Class EmptyParticipant

java.lang.Object

com.e1c.g5.v8.snapshot.participant.EmptyParticipant

All Implemented Interfaces:

ISnapshotParticipant

public class EmptyParticipant
extends Object
implements ISnapshotParticipant

No-op snapshot participant.

Constructor Summary

Constructors

Constructor	Description
EmptyParticipant()

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmptyParticipant

public EmptyParticipant()

Method Detail

configure

public void configure(org.eclipse.core.resources.IProject project,
                      ISnapshotConfigurator configurator)

Description copied from interface: ISnapshotParticipant

Requests the participant to configure snapshot. Called some time before snapshot creation and restoration.

Specified by:

configure in interface ISnapshotParticipant

Parameters:

project - the project for which snapshot is going to be created, cannot be null

configurator - the configurator to configure snapshot, cannot be null

contributeMetadata

public void contributeMetadata(org.eclipse.core.resources.IProject project,
                               String entry,
                               DataOutputStream output)
                        throws IOException

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 interface ISnapshotParticipant

Parameters:

project - the project for which snapshot is being created, cannot be null

entry - the metadata entry name, cannot be null

output - the data output stream to write metadata, cannot be null

Throws:

IOException

restoreMetadata

public void restoreMetadata(org.eclipse.core.resources.IProject project,
                            String entry,
                            DataInputStream input)
                     throws IOException

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 interface ISnapshotParticipant

Parameters:

project - the project for which snapshot is being restored, cannot be null

entry - the metadata entry name, cannot be null

input - the data input stream to read metadata, cannot be null

Throws:

IOException

getFormatVersion

public int getFormatVersion()

Description copied from interface: ISnapshotParticipant

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.

Specified by:

getFormatVersion in interface ISnapshotParticipant

Returns:

the format version of the participant