Home | History | Annotate | Download | only in clearsilver
      1 /*
      2  * Copyright (C) 2010 Google Inc.
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  * http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package org.clearsilver;
     18 
     19 import java.io.IOException;
     20 
     21 /**
     22  * Interface for CS file hook
     23  */
     24 public interface CSFileLoader {
     25 
     26   /**
     27    * Callback method that is expected to return the contents of the specified
     28    * file as a string.
     29    * @param hdf the HDF structure associated with HDF or CS object making the
     30    * callback.
     31    * @param filename the name of the file that should be loaded.
     32    * @return a string containing the contents of the file.
     33    */
     34   public String load(HDF hdf, String filename) throws IOException;
     35 
     36 }
     37