com.helger.commons.io.file.IFileOperationCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.8+ Library with tons of utility classes required in all projects

The newest version!

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.commons.io.file;

import java.io.File;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.callback.ICallback;

/**
 * Callback interface for {@link FileOperationManager}.
 *
 * @author Philip Helger
 */
public interface IFileOperationCallback extends ICallback
{
  /**
   * Called upon operation success.
   *
   * @param eOperation
   *        The operation that succeeded.
   * @param aFile1
   *        The first file worked upon. May not be null.
   * @param aFile2
   *        The second file worked upon. May be null.
   */
  default void onSuccess (@Nonnull final EFileIOOperation eOperation, @Nonnull final File aFile1, @Nullable final File aFile2)
  {}

  /**
   * Called upon operation error.
   *
   * @param eOperation
   *        The operation that failed.
   * @param eErrorCode
   *        The error code that occurred.
   * @param aFile1
   *        The first file worked upon. May not be null.
   * @param aFile2
   *        The second file worked upon. May be null.
   * @param aException
   *        The exception that occurred. May be null.
   */
  default void onError (@Nonnull final EFileIOOperation eOperation,
                        @Nonnull final EFileIOErrorCode eErrorCode,
                        @Nonnull final File aFile1,
                        @Nullable final File aFile2,
                        @Nullable final Exception aException)
  {}
}