KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > script > IScriptToken


1 // Copyright 2004, 2005 The Apache Software Foundation
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 package org.apache.tapestry.script;
16
17 import org.apache.hivemind.Locatable;
18
19
20 /**
21  * Defines the responsibilities of a template token used by a
22  * {@link org.apache.tapestry.IScript}.
23  *
24  * @author Howard Lewis Ship
25  *
26  **/
27
28 public interface IScriptToken extends Locatable
29 {
30     /**
31      * Invoked to have the token
32      * add its text to the buffer. A token may need access
33      * to the symbols in order to produce its output.
34      *
35      * <p>Top level tokens (such as BodyToken) can expect that
36      * buffer will be null.
37      *
38      **/
39
40     public void write(StringBuffer JavaDoc buffer, ScriptSession session);
41
42     /**
43      * Invoked during parsing to add the token parameter as a child
44      * of this token.
45      *
46      * @since 0.2.9
47      **/
48
49     public void addToken(IScriptToken token);
50 }
Popular Tags