View Javadoc

1   package net.sourceforge.blogentis.storage;
2   
3   //-----------------------------------------------------------------------
4   //Blogentis - a blog publishing platform.
5   //Copyright (C) 2004 Tassos Bassoukos <abassouk@gmail.com>
6   //
7   //This library is free software; you can redistribute it and/or
8   //modify it under the terms of the GNU Lesser General Public
9   //License as published by the Free Software Foundation; either
10  //version 2.1 of the License, or (at your option) any later version.
11  //
12  //This library is distributed in the hope that it will be useful,
13  //but WITHOUT ANY WARRANTY; without even the implied warranty of
14  //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  //Lesser General Public License for more details.
16  //
17  //You should have received a copy of the GNU Lesser General Public
18  //License along with this library; if not, write to the Free Software
19  //Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  //-----------------------------------------------------------------------
21  //
22  //$Id: FileResourceFilter.java,v 1.1 2004/10/22 17:34:11 tassos Exp $
23  //
24  
25  /***
26   * This is used in storage tree retrievals to filter itemas and depth of search.
27   * 
28   * @author abas
29   */
30  public interface FileResourceFilter {
31      /***
32       * Check wether this resource should be ignored.
33       * 
34       * @param path
35       *            the full path to check.
36       * @return true if this path should not be added in the tree
37       */
38      public boolean ignored(String path);
39  
40      /***
41       * Should the childern of the folder appear in the tree?
42       * 
43       * @param folder
44       *            the folder to check.
45       * @return true if the tree should include all descendands of folder.
46       */
47      public boolean descendInto(String folder);
48  }