org.apache.axiom.util.blob
Class BlobOutputStream
java.lang.Object
java.io.OutputStream
org.apache.axiom.util.blob.BlobOutputStream
- All Implemented Interfaces:
- Closeable, Flushable, ReadFromSupport
public abstract class BlobOutputStream
- extends OutputStream
- implements ReadFromSupport
Output stream that is used to write to a blob. Instances of this class are returned by the
WritableBlob.getOutputStream()
method.
Method Summary |
abstract WritableBlob |
getBlob()
Get the blob to which this output stream belongs. |
long |
readFrom(InputStream inputStream,
long length)
Read data from the given input stream and write it to this output stream. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
BlobOutputStream
public BlobOutputStream()
getBlob
public abstract WritableBlob getBlob()
- Get the blob to which this output stream belongs.
- Returns:
- the blob
readFrom
public long readFrom(InputStream inputStream,
long length)
throws StreamCopyException
- Description copied from interface:
ReadFromSupport
- Read data from the given input stream and write it to this output stream.
The method transfers data until one of the following conditions is met:
- The end of the input stream is reached.
- The value of the
length
argument is different from -1
and the number of bytes transferred is equal to length
.
- Specified by:
readFrom
in interface ReadFromSupport
- Parameters:
inputStream
- An input stream to read data from. This method will not close the stream.length
- the number of bytes to transfer, or -1
if the method should
transfer data until the end of the input stream is reached
- Returns:
- the number of bytes transferred
- Throws:
StreamCopyException
Copyright © 2004-2013 The Apache Software Foundation. All Rights Reserved.