156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/* 256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Copyright (C) 2010 Google Inc. 356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Licensed under the Apache License, Version 2.0 (the "License"); 556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * you may not use this file except in compliance with the License. 656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * You may obtain a copy of the License at 756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * http://www.apache.org/licenses/LICENSE-2.0 956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * 1056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Unless required by applicable law or agreed to in writing, software 1156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * distributed under the License is distributed on an "AS IS" BASIS, 1256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * See the License for the specific language governing permissions and 1456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * limitations under the License. 1556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 1656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpackage org.clearsilver; 1856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 1956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.File; 2056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.util.LinkedList; 2156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.util.List; 2256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson/** 2456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Utility class containing helper methods 2556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 2656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpublic final class CSUtil { 2756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson private CSUtil() { } 2956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public static final String HDF_LOADPATHS = "hdf.loadpaths"; 3156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 3356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Helper function that returns a concatenation of the loadpaths in the 3456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * provided HDF. 3556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param hdf an HDF structure containing load paths. 3656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @return A list of loadpaths in order in which to search. 3756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @throws NullPointerException if no loadpaths are found. 3856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 3956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public static List<String> getLoadPaths(HDF hdf) { 4056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return getLoadPaths(hdf, false); 4156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 4256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 4456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Helper function that returns a concatenation of the loadpaths in the 4556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * provided HDF. 4656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param hdf an HDF structure containing load paths. 4756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param allowEmpty if {@code true} then this will return an empty list when 4856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * no loadpaths are found in the HDF object, otherwise a 4956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * {@link NullPointerException} is thrown. Loadpaths are not needed if 5056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * no files are read in or are all specified by absolute paths. 5156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @return A list of loadpaths in order in which to search. 5256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @throws NullPointerException if no loadpaths are found and allowEmpty is 5356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * {@code false}. 5456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 5556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public static List<String> getLoadPaths(HDF hdf, boolean allowEmpty) { 5656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson List<String> list = new LinkedList<String>(); 5756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson HDF loadpathsHdf = hdf.getObj(HDF_LOADPATHS); 5856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (loadpathsHdf == null) { 5956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (allowEmpty) { 6056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return list; 6156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } else { 6256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new NullPointerException("No HDF loadpaths located in the " 6356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson + "specified HDF structure"); 6456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 6556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 6656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson for (HDF lpHdf = loadpathsHdf.objChild(); lpHdf != null; 6756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson lpHdf = lpHdf.objNext()) { 6856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson list.add(lpHdf.objValue()); 6956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return list; 7156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 7256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 7356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 7456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Given an ordered list of directories to look in, locate the specified file. 7556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Returns <code>null</code> if file not found. 7656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param loadpaths the ordered list of paths to search. 7756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param filename the name of the file. 7856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @return a File object corresponding to the file. <code>null</code> if 7956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * file not found. 8056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 8156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson public static File locateFile(List<String> loadpaths, String filename) { 8256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (filename == null) { 8356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new NullPointerException("No filename provided"); 8456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 8556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (loadpaths == null) { 8656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson throw new NullPointerException("No loadpaths provided."); 8756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 8856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson for (String path : loadpaths) { 8956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson File file = new File(path, filename); 9056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson if (file.exists()) { 9156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return file; 9256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson return null; 9556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson } 9656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson} 97