001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *   http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 *
017 */
018
019package org.apache.commons.net.ftp;
020
021/**
022 * Performs filtering on {@link FTPFile} instances.
023 *
024 * @since 2.2
025 */
026public interface FTPFileFilter {
027
028    /**
029     * Checks if an FTPFile entry should be included or not.
030     *
031     * @param file entry to be checked for inclusion. May be {@code null}.
032     * @return {@code true} if the file is to be included, {@code false} otherwise.
033     */
034    boolean accept(FTPFile file);
035}