KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > snipsnap > render > macro > SnipMacro


1 /*
2  * This file is part of "SnipSnap Wiki/Weblog".
3  *
4  * Copyright (c) 2002 Stephan J. Schmidt, Matthias L. Jugel
5  * All Rights Reserved.
6  *
7  * Please visit http://snipsnap.org/ for updates and contact.
8  *
9  * --LICENSE NOTICE--
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23  * --LICENSE NOTICE--
24  */
25
26 package org.snipsnap.render.macro;
27
28 import org.radeox.macro.parameter.MacroParameter;
29 import org.radeox.macro.Macro;
30 import org.radeox.macro.BaseMacro;
31 import org.snipsnap.render.macro.parameter.SnipMacroParameter;
32
33 import java.io.IOException JavaDoc;
34 import java.io.Writer JavaDoc;
35
36 /**
37  * Base macro class for macros that deal in a SnipSnap enviroment.
38  * They receive an execute call with SnipMacroParameter instead of
39  * MacroParameter
40  *
41  * @author Stephan J. Schmidt
42  * @version $Id: SnipMacro.java 1031 2003-10-14 08:41:58Z stephan $
43  */
44
45 public abstract class SnipMacro extends BaseMacro {
46   public abstract void execute(Writer JavaDoc writer, SnipMacroParameter params) throws IllegalArgumentException JavaDoc, IOException JavaDoc;
47
48   public void execute(Writer JavaDoc writer, MacroParameter params) throws IllegalArgumentException JavaDoc, IOException JavaDoc {
49     if (params instanceof SnipMacroParameter) {
50       execute(writer, (SnipMacroParameter) params);
51       return;
52     } else {
53       throw new IllegalArgumentException JavaDoc("Macro must be called in a SnipSnap enviroment.");
54     }
55   }
56 }
57
58
Popular Tags