View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  
22  package org.opencastproject.adminui.util;
23  
24  import org.opencastproject.adminui.exception.IllegalPathException;
25  
26  import java.util.List;
27  
28  /**
29   * A simple folder inspection utility.
30   * 
31   * @author ademasi
32   * 
33   */
34  public interface PathInspector {
35  
36    /**
37     * Lists all files in a directory (path), if it exists and is readable.
38     * 
39     * @param languageFileFolder
40     * @return A list of all filenames in a directory.
41     * @throws IllegalPathException
42     *           If the path does not exist or is not readable.
43     */
44    List<String> listFiles(String languageFileFolder) throws IllegalPathException;
45  
46  }