co.codewizards.cloudstore.core.io

Interface LockFile

public interface LockFile

Lock-file exclusively locking a certain file.

An instance is acquired by invoking LockFileFactory.acquire(File, long).

All methods of this interface are thread-safe.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	createInputStream()
OutputStream	createOutputStream()
File	getFile() Gets the underlying file being locked.
Lock	getLock()
void	release() Releases the lock.

Method Detail

getFile

File getFile()

Gets the underlying file being locked.

Returns:

the underlying file being locked. Never null.

release

void release()

Releases the lock.

Important: This method must be called exactly once for every LockFile instance! It is highly recommended to use a try-finally-block:

  LockFile lockFile = LockFileFactory.acquire(theFile, theTimeout);
  try {
    // do something
  } finally {
    lockFile.release();
  }

This method is thread-safe and thus might be invoked on a different thread than the instance was created. However, it must be invoked exactly once (per LockFile instance).

Throws:

IllegalStateException - if this method is invoked more than once on the same instance.

See Also:

LockFileFactory.acquire(File, long)

getLock

Lock getLock()

createInputStream

InputStream createInputStream()
                              throws IOException

Throws:

IOException

createOutputStream

OutputStream createOutputStream()
                                throws IOException

Throws:

IOException