com.pippsford.util.filelock.UniqueFiles Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-utils Show documentation

Code that seems to me to have utility across multiple projects

The newest version!

package com.pippsford.util.filelock;

import java.io.File;
import java.io.IOException;
import java.nio.file.Path;

import com.pippsford.util.FileLockHelper.LockingFile;

/**
 * Interface for managing unique file information across applications within
 * one application server.
 */
public interface UniqueFiles {

  /**
   * Get the single File instance that represents the canonical file
   * specified.
   *
   * @param path the file's path
   *
   * @return the singleton canonical file instance
   *
   * @throws IOException if the locking file cannot be established
   */
  File getCanonicalFile(File path) throws IOException;


  /**
   * Get the single File instance that represents the canonical file
   * specified.
   *
   * @param path the file's path
   *
   * @return the singleton canonical file instance
   *
   * @throws IOException if the file cannot be identified
   */
  File getCanonicalFile(String path) throws IOException;


  /**
   * Get the single File instance that represents the canonical file
   * specified.
   *
   * @param path the file's path
   *
   * @return the singleton canonical file instance
   *
   * @throws IOException if the locking file cannot be established
   */
  LockingFile getLockingFile(Path path) throws IOException;

}