bayou.bytes

Class ByteSourceCache

java.lang.Object

bayou.bytes.ByteSourceCache

public class ByteSourceCache
extends Object

Caches all bytes from a ByteSource in memory.

The cached bytes can be viewed as a ByteSource by newView().

Example Usage: cache a file content in memory

     FileByteSource fileSrc = new FileByteSource("/tmp/data.bin");
     ByteSourceCache cache = new ByteSourceCache(fileSrc, null);

     // read bytes from the cache
     ByteSource view = cache.newView();
     AsyncIterator.forEach( view::read, System.out::println ).finally_( view::close );
 

If an error occurred while the cache reads the origin source, the error will be reflected when reading from views.

Constructor Summary

Constructors

Constructor and Description
ByteSourceCache(ByteSource origin, Long totalBytes) Create an in-memory cache of the origin source.

Method Summary

Instance Methods
Long	getTotalBytes() Return the total number of bytes in the origin source; null if unknown yet.
ByteSource	newView() Create a ByteSource view of the cached bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteSourceCache

public ByteSourceCache(ByteSource origin,
                       Long totalBytes)

Create an in-memory cache of the origin source.

Parameters:

totalBytes - total number of bytes in the origin source. null if unknown.

Method Detail

getTotalBytes

public Long getTotalBytes()

Return the total number of bytes in the origin source; null if unknown yet.

This number may be unknown initially (because it was not supplied to the constructor). However, it eventually becomes known after the cache reads all bytes from the origin source (barring any error).

This number may be useful, for example, in Content-Length header of http responses.

newView

public ByteSource newView()

Create a ByteSource view of the cached bytes.

This method is thread-safe.