org.apache.axiom.blob

## Interface OverflowableBlob

- All Superinterfaces:
    Blob, WritableBlob

      public interface OverflowableBlob
      extends WritableBlob

  Blob that accumulates data in memory and transfers it to a different type of blob if the size exceeds a certain threshold. Typically the overflow blob (i.e. the blob that is created if the memory buffer overflows) stores data in a temporary file. It is therefore mandatory to call `WritableBlob.release()` to discard the blob.

  Instances are created with `Blobs.createOverflowableBlob(int, WritableBlobFactory)` or any of the other methods returning `OverflowableBlob`.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `WritableBlob` | `getOverflowBlob()` Get a reference to the overflow blob.

    - ### Methods inherited from interface org.apache.axiom.blob.WritableBlob

      `getOutputStream, readFrom, release`

    - ### Methods inherited from interface org.apache.axiom.blob.Blob

      `getInputStream, getSize, writeTo`

- - ### Method Detail

    - #### getOverflowBlob

          WritableBlob getOverflowBlob()

      Get a reference to the overflow blob. The overflow blob is created only if the size of the blob exceeds the threshold. The method returns `null` if that's not the case.
      Returns:
        the overflow blob, or `null` if this blob hasn't overflown

Copyright © The Apache Software Foundation. All Rights Reserved.