org.eclipse.tycho.repository.p2base.artifact.repository

Class ArtifactRepositoryBaseImpl.AddingArtifactSink

java.lang.Object

org.eclipse.tycho.repository.p2base.artifact.repository.ArtifactRepositoryBaseImpl.AddingArtifactSink

All Implemented Interfaces:

IArtifactSink

Direct Known Subclasses:

ArtifactRepositoryBaseImpl.RawAddingArtifactSink

Enclosing class:

ArtifactRepositoryBaseImpl<ArtifactDescriptorT extends org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor>

private class ArtifactRepositoryBaseImpl.AddingArtifactSink
extends java.lang.Object
implements IArtifactSink

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	committed
private java.io.OutputStream	currentOutputStream
protected ArtifactDescriptorT	newDescriptor

Constructor Summary

Constructors

Constructor and Description
AddingArtifactSink(ArtifactDescriptorT newDescriptor)

Method Summary

Modifier and Type	Method and Description
void	abortWrite() Method for aborting the write operation.
java.io.OutputStream	beginWrite() Method for starting the write operation.
boolean	canBeginWrite() Check if IArtifactSink.beginWrite() can be called on this instance.
void	commitWrite() Method to committing the write operation.
org.eclipse.equinox.p2.metadata.IArtifactKey	getArtifactToBeWritten() Returns the key of the artifact expected by this instance.

Methods inherited from class java.lang.Object

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

Field Detail

newDescriptor

protected final ArtifactDescriptorT extends org.eclipse.equinox.p2.repository.artifact.IArtifactDescriptor newDescriptor

currentOutputStream

private java.io.OutputStream currentOutputStream

committed

private boolean committed

Constructor Detail

AddingArtifactSink

AddingArtifactSink(ArtifactDescriptorT newDescriptor)
            throws org.eclipse.equinox.p2.core.ProvisionException

Throws:

org.eclipse.equinox.p2.core.ProvisionException

Method Detail

getArtifactToBeWritten

public org.eclipse.equinox.p2.metadata.IArtifactKey getArtifactToBeWritten()

Description copied from interface: IArtifactSink

Returns the key of the artifact expected by this instance.

Specified by:

getArtifactToBeWritten in interface IArtifactSink

canBeginWrite

public boolean canBeginWrite()

Description copied from interface: IArtifactSink

Check if IArtifactSink.beginWrite() can be called on this instance. This method will typically return false if IArtifactSink.commitWrite() has already been called on this instance, or if IArtifactSink.beginWrite() has been called before and the instance doesn't support re-starting the write operation.

Specified by:

canBeginWrite in interface IArtifactSink

Returns:

true if IArtifactSink.beginWrite() can be called on this instance.

beginWrite

public java.io.OutputStream beginWrite()
                                throws java.lang.IllegalStateException,
                                       ArtifactSinkException

Description copied from interface: IArtifactSink

Method for starting the write operation. If this method has been called before, any content written so far will be discarded.

Specified by:

beginWrite in interface IArtifactSink

Returns:

the OutputStream to write the artifact content to. The ownership of the stream is not transferred to the caller, i.e. OutputStream.close() must not be called on the returned instance. Instead, call IArtifactSink.commitWrite() or IArtifactSink.abortWrite() to free any allocated resources.

Throws:

java.lang.IllegalStateException - if this instance is not in the right state to start a write operation. This exception will be thrown if and only if IArtifactSink.canBeginWrite() returns false.

ArtifactSinkException - if an error occurs while starting the write operation.

commitWrite

public void commitWrite()
                 throws java.lang.IllegalStateException,
                        ArtifactSinkException

Description copied from interface: IArtifactSink

Method to committing the write operation. Will be called after the entire artifact content has been successfully streamed to the OutputStream returned by IArtifactSink.beginWrite().

Specified by:

commitWrite in interface IArtifactSink

Throws:

java.lang.IllegalStateException - if there is no running write operation, i.e. when this method has already been called, IArtifactSink.abortWrite() has been called, or IArtifactSink.beginWrite() has not been called.

ArtifactSinkException - if an error occurs while committing the write operation.

abortWrite

public void abortWrite()
                throws ArtifactSinkException

Description copied from interface: IArtifactSink

Method for aborting the write operation. Should be called if an error is detected while streaming the artifact content.

Specified by:

abortWrite in interface IArtifactSink

Throws:

ArtifactSinkException - if an error occurs while aborting the write operation.