com.atlassian.plugin.cache.filecache.impl

Class StreamsCache

java.lang.Object

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

Direct Known Subclasses:

OneStreamCache, TwoStreamsCache

public abstract class StreamsCache
extends Object

Base class for caching streams, mostly contains concurrency related logic, the file operations implemented in children.

Since:

v3.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	StreamsCache.Callback
protected static interface	StreamsCache.CallbackWithBooleanReturn

Constructor Summary

Constructors

Constructor and Description
StreamsCache()

Method Summary

Modifier and Type	Method and Description
protected OutputStream	createWriteStream(File file)
abstract void	deleteWhenPossible()
void	deleteWhenPossible(StreamsCache.Callback callback)
protected boolean	doEnter(StreamsCache.Callback streamCallback, StreamsCache.CallbackWithBooleanReturn checkFilesCallback) Increments the concurrent count, and returns if it is okay to read from the cached file, or not.
protected void	doExit(StreamsCache.Callback callback) Decrements the concurrent count.
void	setLogger(org.slf4j.Logger log) Needed for tests.
abstract void	stream(OutputStream out, Cache.StreamProvider provider)
protected static void	streamFromFile(File file, OutputStream out)
abstract void	streamTwo(OutputStream out1, OutputStream out2, Cache.TwoStreamProvider provider)

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamsCache

public StreamsCache()

Method Detail

deleteWhenPossible

public void deleteWhenPossible(StreamsCache.Callback callback)

stream

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

streamTwo

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

deleteWhenPossible

public abstract void deleteWhenPossible()

doEnter

protected boolean doEnter(StreamsCache.Callback streamCallback,
                          StreamsCache.CallbackWithBooleanReturn checkFilesCallback)

Increments the concurrent count, and returns if it is okay to read from the cached file, or not. If necessary, it will create the cached file first. doExit() must be called iff this method returns normally

doExit

protected void doExit(StreamsCache.Callback callback)

Decrements the concurrent count. Will delete the cache if requested, and there are no other concurrent users.

streamFromFile

protected static void streamFromFile(File file,
                                     OutputStream out)

createWriteStream

protected OutputStream createWriteStream(File file)
                                  throws FileNotFoundException

Throws:

FileNotFoundException

setLogger

public void setLogger(org.slf4j.Logger log)

Needed for tests.