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.template; 18 19 import com.google.clearsilver.jsilver.exceptions.JSilverInterpreterException; 20 21 /** 22 * An executable macro. This exhibits all the same characteristics of a Template. 23 */ 24 public interface Macro extends Template { 25 26 /** 27 * Name of macro (e.g. showTable). Used to generate error messages. 28 */ getMacroName()29 String getMacroName(); 30 31 /** 32 * Get the name of the nth argument defined in the macro. Throws exception if the argument is not 33 * found. 34 */ getArgumentName(int index)35 String getArgumentName(int index) throws JSilverInterpreterException; 36 37 /** 38 * Return the number of arguments this macro expects. Must be equal to the number of arguments 39 * supplied. 40 */ getArgumentCount()41 int getArgumentCount(); 42 } 43