001// Copyright 2006, 2011 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.tapestry5.internal.parser;
016
017import org.apache.tapestry5.MarkupWriter;
018import org.apache.tapestry5.commons.Location;
019import org.apache.tapestry5.runtime.RenderCommand;
020import org.apache.tapestry5.runtime.RenderQueue;
021
022/**
023 * A node representing a comment embedded in the source input.
024 */
025public class CommentToken extends TemplateToken implements RenderCommand
026{
027    public final String comment;
028
029    public CommentToken(String comment, Location location)
030    {
031        super(TokenType.COMMENT, location);
032
033        this.comment = comment;
034    }
035
036    public void render(MarkupWriter writer, RenderQueue queue)
037    {
038        writer.comment(comment);
039    }
040
041    @Override
042    public String toString()
043    {
044        return String.format("Comment[%s]", comment);
045    }
046}