com.sun.jersey.api.client

Class CommittingOutputStream

java.lang.Object

java.io.OutputStream

com.sun.jersey.api.client.CommittingOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public abstract class CommittingOutputStream
extends OutputStream

A committing output stream that commits before the first byte is written to the adapted OutputStream.

This class may be overridden to provide the commit functionality.

Author:

Paul Sandoz

Constructor Summary

Constructors

Constructor and Description
CommittingOutputStream() Construct a new instance.
CommittingOutputStream(OutputStream adaptedOutput) Construct a new instance with an output stream to adapt.

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract void	commit() Perform the commit functionality.
void	flush()
protected OutputStream	getOutputStream() Get the adapted output stream.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommittingOutputStream

public CommittingOutputStream()

Construct a new instance.

The method getOutputStream() MUST be overridden to return an output stream.

CommittingOutputStream

public CommittingOutputStream(OutputStream adaptedOutput)

Construct a new instance with an output stream to adapt.

Parameters:

adaptedOutput - the adapted output stream.

Throws:

IllegalArgumentException - if adaptedOutput is null.

Method Detail

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

getOutputStream

protected OutputStream getOutputStream()
                                throws IOException

Get the adapted output stream.

This method MUST be overridden if the empty constructor is utilized to construct an instance of this class.

Returns:

the adapted output stream.

Throws:

IOException - if obtaining of an output stream fails (e.g. connection problem).

commit

protected abstract void commit()
                        throws IOException

Perform the commit functionality.

Throws:

IOException