/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.gobblin.data.management.copy;

import java.util.Collection;

import org.apache.hadoop.fs.FileSystem;


/**
 * A filter that is applied on all the {@link CopyableFile}s found by
 * {@link CopyableDataset#getCopyableFiles(FileSystem, CopyConfiguration)}.
 */
public interface CopyableFileFilter {

  /**
   * Returns an filtered {@link Collection} of {@link CopyableFile}s. The filtering logic is implemented by the subclass
   *
   * @param sourceFs of the copyableFiles
   * @param targetFs of the copyableFiles
   * @param copyableFiles to be filtered
   *
   * @return a filtered collection of copyableFiles
   */
  public Collection<CopyableFile> filter(FileSystem sourceFs, FileSystem targetFs,
      Collection<CopyableFile> copyableFiles);

}
