001// Copyright 2004, 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry.script;
016
017import org.apache.hivemind.Locatable;
018
019
020/**
021 *  Defines the responsibilities of a template token used by a
022 *  {@link org.apache.tapestry.IScript}.
023 *
024 *  @author Howard Lewis Ship
025 * 
026 **/
027
028public interface IScriptToken extends Locatable
029{
030        /**
031         *  Invoked to have the token
032         *  add its text to the buffer.  A token may need access
033         *  to the symbols in order to produce its output.
034         *
035         *  <p>Top level tokens (such as BodyToken) can expect that
036         *  buffer will be null.
037         *
038         **/
039
040        public void write(StringBuffer buffer, ScriptSession session);
041
042        /**
043         *  Invoked during parsing to add the token parameter as a child
044         *  of this token.
045         *
046         *  @since 0.2.9
047         **/
048
049        public void addToken(IScriptToken token);
050}