net.sf.staccatocommons.testing.mock.FileMock Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-testing Show documentation
Testing components build on top of JUnit 4
The newest version!
/**
 *  Copyright (c) 2011, The Staccato-Commons Team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation; version 3 of the License.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 */

/*
 Copyright (c) 2010, The Staccato-Commons Team

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
 the Free Software Foundation; version 3 of the License.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Lesser General Public License for more details.
 */
package net.sf.staccatocommons.testing.mock;

import java.io.File;
import java.io.FileFilter;
import java.io.FilenameFilter;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URL;

/**
 * A dummy, read only, unexecutable, existent {@link File} mock
 * 
 * Methods supported are:
 * 
 * {@link #exists()} : returns true
 * {@link #listFiles()} : returns a provided list of files, if mock was
 * created as a file. Otherwise, null, in order to be consistent
 * with File interface
 * {@link #isDirectory()} : returns if the mock was created as a file
 * {@link #isFile()} : returns !{@link #isDirectory()}
 * {@link #canExecute()} : returns false
 * {@link #canRead()} : returns true
 * {@link #canWrite()} : returns false
 * {@link #getName()} : same behavior of {@link File}
 * {@link #getPath()} : same behavior of {@link File}
 * {@link #toString()} : same behavior of {@link File}
 * {@link #getAbsolutePath()} : same behavior of {@link File}
 * 
 * 
 * @author flbulgarelli
 * 
 */
public class FileMock extends File {
  private static final long serialVersionUID = -4997788227815563688L;
  private final File[] contents;
  private final boolean readable;

  protected FileMock(String pathname, File... contents) {
    this(pathname, true, contents);
  }

  protected FileMock(String pathname, boolean readable, File... contents) {
    super(pathname);
    this.contents = contents;
    this.readable = readable;
  }

  public boolean exists() {
    return true;
  }

  public File[] listFiles() {
    return contents;
  }

  public boolean isDirectory() {
    return contents != null;
  }

  public boolean canExecute() {
    return false;
  }

  public boolean canRead() {
    return exists() && readable;
  }

  public boolean canWrite() {
    return true;
  }

  public boolean isFile() {
    return !isDirectory();
  }

  public String getAbsolutePath() {
    return super.getAbsolutePath();
  }

  public File getCanonicalFile() throws IOException {
    throw new UnsupportedOperationException();
  }

  public String getCanonicalPath() throws IOException {
    throw new UnsupportedOperationException();
  }

  public String getParent() {
    throw new UnsupportedOperationException();
  }

  public File getParentFile() {
    throw new UnsupportedOperationException();
  }

  public int hashCode() {
    return super.hashCode();
  }

  public boolean equals(Object obj) {
    return super.equals(obj);
  }

  public String[] list() {
    throw new UnsupportedOperationException();
  }

  public String[] list(FilenameFilter filter) {
    throw new UnsupportedOperationException();
  }

  public File[] listFiles(FileFilter filter) {
    throw new UnsupportedOperationException();
  }

  public File getAbsoluteFile() {
    throw new UnsupportedOperationException();
  }

  public long getFreeSpace() {
    throw new UnsupportedOperationException();
  }

  public long getTotalSpace() {
    throw new UnsupportedOperationException();
  }

  public long getUsableSpace() {
    throw new UnsupportedOperationException();
  }

  public boolean isAbsolute() {
    throw new UnsupportedOperationException();
  }

  public boolean isHidden() {
    throw new UnsupportedOperationException();
  }

  public long lastModified() {
    throw new UnsupportedOperationException();
  }

  public long length() {
    throw new UnsupportedOperationException();
  }

  public int compareTo(File pathname) {
    return super.compareTo(pathname);
  }

  public boolean createNewFile() throws IOException {
    throw new UnsupportedOperationException();
  }

  public boolean delete() {
    throw new UnsupportedOperationException();
  }

  public void deleteOnExit() {
    throw new UnsupportedOperationException();
  }

  public boolean mkdir() {
    throw new UnsupportedOperationException();
  }

  public boolean mkdirs() {
    throw new UnsupportedOperationException();
  }

  public boolean renameTo(File dest) {
    throw new UnsupportedOperationException();
  }

  public boolean setExecutable(boolean executable, boolean ownerOnly) {
    throw new UnsupportedOperationException();
  }

  public boolean setExecutable(boolean executable) {
    throw new UnsupportedOperationException();
  }

  public boolean setLastModified(long time) {
    throw new UnsupportedOperationException();
  }

  public boolean setReadOnly() {
    throw new UnsupportedOperationException();
  }

  public boolean setReadable(boolean readable, boolean ownerOnly) {
    throw new UnsupportedOperationException();
  }

  public boolean setReadable(boolean readable) {
    throw new UnsupportedOperationException();
  }

  public boolean setWritable(boolean writable, boolean ownerOnly) {
    throw new UnsupportedOperationException();
  }

  public boolean setWritable(boolean writable) {
    throw new UnsupportedOperationException();
  }

  public URI toURI() {
    throw new UnsupportedOperationException();
  }

  public URL toURL() throws MalformedURLException {
    throw new UnsupportedOperationException();
  }

  /**
   * Creates a {@link FileMock} that represents a directory
   * 
   * @param pathname
   *          the name of the fake directory.
   * @param contents
   *          the files listed on it. May be empty.
   * @return a new {@link FileMock}
   */
  public static FileMock dir(String pathname, File... contents) {
    return new FileMock(pathname, contents);
  }

  /**
   * Creates a {@link FileMock} that represents a regular file
   * 
   * @param pathname
   *          the name of the fake file
   * @return a new {@link FileMock}
   */
  public static FileMock file(String pathname) {
    return new FileMock(pathname, (File[]) null);
  }

  /**
   * Creates a {@link FileMock} that represents a regular file
   * 
   * @param pathname
   *          the name of the fake file
   * @return a new {@link FileMock}
   */
  public static FileMock unreadableFile(String pathname) {
    return new FileMock(pathname, false, (File[]) null);
  }

}