com.atlassian.plugin.cache.filecache.impl

Class OneStreamCache

java.lang.Object

com.atlassian.plugin.cache.filecache.impl.StreamsCache

com.atlassian.plugin.cache.filecache.impl.OneStreamCache

public class OneStreamCache
extends StreamsCache

Caches the contents of a stream, and deletes the cache when asked to do so. This class encapsulates the lifecycle of a cached file, from as-yet-uncached, to cached, to needs-deletion, to deleted.

Calls to stream() always succeed, even if the cache was deleted. The initial call to stream() will block other callers to stream() and deleteWhenPossible().

Subsequent calls to stream() don't block other calls.

Subsequent calls to deleteWhenPossible() don't block.

A call to deleteWhenPossible() always results in the file being (eventually) deleted.

Both stream() and deleteWhenPossible() can be called multiple times, in any order, with any level of concurrency.

Since:

v3.3

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.plugin.cache.filecache.impl.StreamsCache

StreamsCache.Callback, StreamsCache.CallbackWithBooleanReturn

Field Summary

Fields

Modifier and Type	Field and Description
protected File	tmpFile

Constructor Summary

Constructors

Constructor and Description
OneStreamCache(File tmpFile)

Method Summary

Modifier and Type	Method and Description
void	deleteWhenPossible()
void	stream(OutputStream out, Cache.StreamProvider provider)
protected void	streamToCache(Cache.StreamProvider input)
void	streamTwo(OutputStream out1, OutputStream out2, Cache.TwoStreamProvider provider)

Methods inherited from class com.atlassian.plugin.cache.filecache.impl.StreamsCache

createWriteStream, deleteWhenPossible, doEnter, doExit, setLogger, streamFromFile

Methods inherited from class java.lang.Object

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

Field Detail

tmpFile

protected final File tmpFile

Constructor Detail

OneStreamCache

public OneStreamCache(File tmpFile)

Method Detail

stream

public void stream(OutputStream out,
                   Cache.StreamProvider provider)

Specified by:

stream in class StreamsCache

streamTwo

public void streamTwo(OutputStream out1,
                      OutputStream out2,
                      Cache.TwoStreamProvider provider)

Specified by:

streamTwo in class StreamsCache

deleteWhenPossible

public void deleteWhenPossible()

Specified by:

deleteWhenPossible in class StreamsCache

streamToCache

protected void streamToCache(Cache.StreamProvider input)
                      throws IOException

Throws:

IOException