    001// Copyright 2007 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.commons.Location;
    018
    019/**
    020 * A block, used to enclose a chunk of template (including components) and control when or if the content is rendered.
    021 */
    022public class BlockToken extends TemplateToken
    023{
    024    private final String id;
    025
    026    /**
    027     * @param id       the id of the block, or null for an anonymous block
    028     * @param location of the block element
    029     */
    030    public BlockToken(String id, Location location)
    031    {
    032        super(TokenType.BLOCK, location);
    033
    034        this.id = id;
    035    }
    036
    037    /**
    038     * Returns the block's template-unique id, or null if the block element did not specify an id.
    039     */
    040    public String getId()
    041    {
    042        return id;
    043    }
    044
    045    @Override
    046    public String toString()
    047    {
    048        return String.format("Block[%s]", id == null ? "" : id);
    049    }
    050}