platform/core-api/src/com/intellij/openapi/roots/ContentIterator.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.openapi.roots;
  17
  18 import com.intellij.openapi.vfs.VirtualFile;
  19 import org.jetbrains.annotations.NotNull;
  20
  21 /**
  22  * Interface which can be used to receive the contents of a project.
  23  *
  24  * @see FileIndex#iterateContent(ContentIterator)
  25  */
  26 @FunctionalInterface
  27 public interface ContentIterator {
  28   /**
  29    * Processes the specified file or directory.
  30    *
  31    * @param fileOrDir the file or directory to process.
  32    * @return false if files processing should be stopped, true if it should be continued.
  33    */
  34   boolean processFile(@NotNull VirtualFile fileOrDir);
  35 }