1 /*

     2  * Copyright 2007-2009 Sun Microsystems, Inc.  All Rights Reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Sun in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

    25 

    26 package java.nio.file;

    27 

    28 import java.io.IOException;

    29 

    30 /**

    31  * An interface that is implemented by objects that operate on a file. An

    32  * implementation of this interface is provided to the {@link Files#withDirectory

    33  * withDirectory} utility method so that the file action is {@link #invoke

    34  * invoked} for all accepted entries in the directory, after which, the directory

    35  * is automatically closed.

    36  *

    37  * <p> <b>Usage Example:</b>

    38  * Suppose we require to perform a task on all class files in a directory:

    39  * <pre>

    40  *     Path dir = ...

    41  *     Files.withDirectory(dir, "*.class", new FileAction<Path>() {

    42  *         public void invoke(Path entry) {

    43  *             :

    44  *         }

    45  *     });

    46  * </pre>

    47  *

    48  * @param   <T>     The type of file reference

    49  *

    50  * @since 1.7

    51  */

    52 

    53 public interface FileAction<T extends FileRef> {

    54     /**

    55      * Invoked for a file.

    56      *

    57      * @param   file

    58      *          The file

    59      *

    60      * @throws  IOException

    61      *          If the block terminates due an uncaught I/O exception

    62      */

    63     void invoke(T file) throws IOException;

    64 }