Home | History | Annotate | Download | only in functions
      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 com.google.clearsilver.jsilver.functions;
     18 
     19 import com.google.clearsilver.jsilver.values.Value;
     20 
     21 import java.io.IOException;
     22 
     23 /**
     24  * Execute functions in templates.
     25  */
     26 public interface FunctionExecutor {
     27 
     28   /**
     29    * Lookup a function by name, execute it and return the results.
     30    */
     31   Value executeFunction(String functionName, Value... args);
     32 
     33   /**
     34    * Escapes some text.
     35    *
     36    * @param name Strategy for escaping text. If null or "none", text will be left as is.
     37    * @param input Text to be escaped.
     38    * @param output Where to write the result to.
     39    */
     40   void escape(String name, String input, Appendable output) throws IOException;
     41 
     42   /**
     43    * Look up a function by name, and report whether it is an escaping function.
     44    */
     45   boolean isEscapingFunction(String name);
     46 }
     47