js.wood.FilesHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wood Show documentation

WOOD tool promotes an object oriented development paradigm for user interfaces based on web technologies. It uses decomposition of complex user interfaces into user interface components.

There is a newer version: 1.0.3-alpha

Show newest version

package js.wood;

/**
 * Abstract handler for directory files iteration. This class is designed to be used in conjunction with
 * {@link DirPath#files(FilesHandler)} class. Create an anonymous subclass and overwrite methods of interest, see
 * samples below.
 * 
 * Here is an example for listing all files, direct child, from a directory.
 * 
 * 
 * dir.files(new FilesHandler()
 * {
 *   public void onFile(FilePath file) throws Exception
 *   {
 *     // handle the file
 *   }
 * });
 * 
 * 
 * Note that above snippet traverses only direct child files. To scan entire files hierarchy one may use an recursive
 * approach.
 * 
 * 
 * public void scan(DirPath dir)
 * {
 *   dir.files(new FilesHandler()
 *   {
 *     public void onDirectory(DirPath dir) throws Exception
 *     {
 *       scan(dir);
 *     }
 * 
 *     public void onFile(FilePath file) throws Exception
 *     {
 *       // handle the file
 *     }
 *   });
 * }
 * 
 * 
 * 
 * @author Iulian Rotaru
 * @since 1.0
 */
public abstract class FilesHandler
{
  /**
   * Sub-directory handler. Invoked when a sub-directory is found.
   * 
   * @param dir sub-directory.
   * @throws Exception exceptions from sub-directory processing are bubbled up.
   */
  public void onDirectory(DirPath dir) throws Exception
  {
  }

  /**
   * If this predicate returns true {@link #onFile(FilePath)} is invoked, otherwise file is skipped. Default
   * implementation always returns true.
   * 
   * @param file file path.
   * @return true if file is accepted.
   */
  public boolean accept(FilePath file)
  {
    return true;
  }

  /**
   * Handler invoked for files from directory if {@link #accept(FilePath)} predicate grant it.
   * 
   * @param file file path.
   * @throws Exception any exception from file processing is bubbled up.
   */
  public void onFile(FilePath file) throws Exception
  {
  }
}