public class MultiReferenceStorage extends Object implements Storage
A wrapper around another Storage
that also maintains a reference
counter. The inner storage gets deleted only if the reference counter reaches
zero.
Reference counting is used to delete the storage when it is no longer needed. So, any users of this class should note:
addReference()
should be called when the storage is shared.addReference()
should ensure that
delete()
is called once and only once.Storage
instance passed into
MultiReferenceStorage(Storage)
may lead to miscounting and premature
deletionConstructor and Description |
---|
MultiReferenceStorage(Storage storage)
Creates a new
MultiReferenceStorage instance for the given
back-end. |
Modifier and Type | Method and Description |
---|---|
void |
addReference()
Increments the reference counter.
|
void |
delete()
Decrements the reference counter and deletes the inner
Storage object if the reference counter reaches zero. |
InputStream |
getInputStream()
Returns the input stream of the inner
Storage object. |
public MultiReferenceStorage(Storage storage)
MultiReferenceStorage
instance for the given
back-end. The reference counter is initially set to one so the caller
does not have to call addReference()
after this constructor.storage
- storage back-end that should be reference counted.IllegalArgumentException
- when storage is nullpublic void addReference()
IllegalStateException
- if the reference counter is zero which implies that the
backing storage has already been deleted.public void delete()
Storage
object if the reference counter reaches zero.
A client that holds a reference to this object must make sure not to invoke this method a second time.
delete
in interface Storage
IllegalStateException
- if the reference counter is zero which implies that the
backing storage has already been deleted.public InputStream getInputStream() throws IOException
Storage
object.getInputStream
in interface Storage
IOException
- if an I/O error occurs.Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.