View Javadoc

1   /*
2    * JDiskCatalog
3    *
4    * Copyright 2007 Przemek Więch
5    *
6    * This file is part of JDiskCatalog.
7    *
8    * JDiskCatalog is free software; you can redistribute it and/or modify
9    * it under the terms of the GNU General Public License as published by
10   * the Free Software Foundation; either version 2 of the License, or
11   * (at your option) any later version.
12   *
13   * This program is distributed in the hope that it will be useful,
14   * but WITHOUT ANY WARRANTY; without even the implied warranty of
15   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16   * GNU General Public License for more details.
17  
18   * You should have received a copy of the GNU General Public License
19   * along with this program; if not, write to the Free Software
20   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
21   */
22  
23  package net.sf.jdiskcatalog.api;
24  
25  import java.io.File;
26  import java.io.IOException;
27  import java.util.Map;
28  
29  /**
30   * Analyses a given file.
31   *
32   * @author Przemek Więch <pwiech@losthive.org>
33   * @version $Id$
34   */
35  public interface FileAnalyser
36  {
37  	/**
38  	 * Analyses a given file.
39  	 * @param file  file to be analysed
40  	 * @param nodeInfo  contains information about this file that was gathered up to now.
41  	 * @return  map containing attributes to be added to the file information.
42  	 */
43  	public Map<String, Object> analyse(File file, NodeInfo nodeInfo) throws IOException;
44  }