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.Closeable; 2056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonimport java.io.IOException; 2156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodsonpublic interface CS extends Closeable { 2356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 2556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Specify a new/different global HDF 2656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 2756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson void setGlobalHDF(HDF global); 2856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 2956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 3056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Return global hdf in use 3156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 3256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson HDF getGlobalHDF(); 3356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 3556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Clean up CS object state. 3656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 3756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson void close(); 3856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 3956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 4056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Parses the specified file as if it has template content. The file will 4156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * be located using the HDF's loadpaths. 4256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param filename the name of file to read in and parse. 4356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @throws java.io.FileNotFoundException if the specified file does not 4456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * exist. 4556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @throws IOException other problems reading the file. 4656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 4756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson void parseFile(String filename) throws IOException; 4856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 4956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 5056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Parse the given string as a CS template. 5156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param content string to parse. 5256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 5356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson void parseStr(String content); 5456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 5556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 5656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Generate output from the CS templates and HDF objects that have been read 5756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * in. 5856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @return the output of the template rendering. 5956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 6056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson String render(); 6156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 6256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 6356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Get the file loader in use, if any. 6456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @return the file loader in use. 6556ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 6656ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson CSFileLoader getFileLoader(); 6756ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 6856ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson /** 6956ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * Set the CS file loader to use 7056ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson * @param fileLoader the file loader that should be used. 7156ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson */ 7256ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson void setFileLoader(CSFileLoader fileLoader); 7356ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson 7456ed4167b942ec265f9cee70ac4d71d10b3835ceBen Dodson} 75