com.phloc.commons.io.file.EFileIOErrorCode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-commons Show documentation
phloc very basic stuff
There is a newer version: 5.0.0
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.phloc.commons.io.file;

import java.io.File;

import javax.annotation.Nonnull;

import com.phloc.commons.state.ISuccessIndicator;

/**
 * Represents a set of predefined error codes that can occur in file operations.
 * 
 * @author Philip Helger
 */
public enum EFileIOErrorCode implements ISuccessIndicator
{
  /** Generic error code: no error. */
  NO_ERROR,
  /** Generic error code: operation failed but we don't know why. */
  OPERATION_FAILED,
  /** Generic error code: a SecurityException occurred. */
  SECURITY_ERROR,
  /** A source file or directory does not exist. */
  SOURCE_DOES_NOT_EXIST,
  /** A destination file or directory already exists. */
  TARGET_ALREADY_EXISTS,
  /** Source and destination object are identical. */
  SOURCE_EQUALS_TARGET,
  /** Avoid recursive dependencies. */
  TARGET_IS_CHILD_OF_SOURCE,
  /** We stumble across an object that is neither a file nor a directory. */
  OBJECT_CANNOT_BE_HANDLED,
  /** An object's parent could not be retrieved. */
  OBJECT_HAS_NO_PARENT,
  /** The source object cannot be read. */
  SOURCE_NOT_READABLE,
  /** The source parent object is read-only (not writable). */
  SOURCE_PARENT_NOT_WRITABLE,
  /** The target parent object is read-only (not writable). */
  TARGET_PARENT_NOT_WRITABLE;

  @Nonnull
  public FileIOError getAsIOError (@Nonnull final EFileIOOperation eOperation, @Nonnull final File aFile)
  {
    return new FileIOError (eOperation, this, aFile);
  }

  @Nonnull
  public FileIOError getAsIOError (@Nonnull final EFileIOOperation eOperation,
                                   @Nonnull final File aFile1,
                                   @Nonnull final File aFile2)
  {
    if (eOperation.getParamCount () < 2)
      throw new IllegalStateException ("The operation " + eOperation + " expects only one parameter!");
    return new FileIOError (eOperation, this, aFile1, aFile2);
  }

  /**
   * @return true if this is {@link #NO_ERROR} , false
   *         otherwise.
   */
  public boolean isSuccess ()
  {
    return this == NO_ERROR;
  }

  /**
   * @return true if this is any other value than {@link #NO_ERROR}
   *         , false otherwise.
   */
  public boolean isFailure ()
  {
    return this != NO_ERROR;
  }

  /**
   * Static method to create a {@link FileIOError} for a
   * {@link SecurityException}.
   * 
   * @param eOperation
   *        The performed operation. May not be null.
   * @param ex
   *        The occurred {@link SecurityException}. Never null.
   * @return The non-null {@link FileIOError}.
   */
  @Nonnull
  public static FileIOError getAsIOError (@Nonnull final EFileIOOperation eOperation,
                                          @Nonnull final SecurityException ex)
  {
    return new FileIOError (eOperation, EFileIOErrorCode.SECURITY_ERROR, ex);
  }
}