View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   *
17   */
18  
19  package org.apache.commons.net.ftp;
20  
21  /**
22   * Perform filtering on FTPFile entries.
23   * @since 2.2
24   */
25  public interface FTPFileFilter {
26      /**
27       * Checks if an FTPFile entry should be included or not.
28       *
29       * @param file entry to be checked for inclusion. May be <code>null</code>.
30       * @return <code>true</code> if the file is to be included, <code>false</code> otherwise
31       */
32      public boolean accept(FTPFile file);
33  }