Package com.e1c.g5.v8.snapshot.participation

Class AbstractSnapshotParticipant

java.lang.Object

com.e1c.g5.v8.snapshot.participation.AbstractSnapshotParticipant

All Implemented Interfaces:

ISnapshotParticipant

Direct Known Subclasses:

StandardSnapshotParticipant, TextSearchIndexSnapshotParticipant

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

Modifier and Type	Method	Description
void	contributeMetadata(org.eclipse.core.resources.IProject project, String entry, OutputStream output)	Requests the participant to contribute metadata for the previously configured metadata entry.
void	restoreMetadata(org.eclipse.core.resources.IProject project, String entry, InputStream 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

Constructor Details

AbstractSnapshotParticipant

public AbstractSnapshotParticipant()

Method Details

contributeMetadata

public void contributeMetadata(org.eclipse.core.resources.IProject project,
 String entry,
 OutputStream 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 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 output stream to write metadata, cannot be null

restoreMetadata

public void restoreMetadata(org.eclipse.core.resources.IProject project,
 String entry,
 InputStream 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 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 input stream to read metadata, cannot be null