freemarker-core/src/main/java/org/apache/freemarker/core/ASTExpBooleanLiteral.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.freemarker.core;

import org.apache.freemarker.core.model.TemplateBooleanModel;
import org.apache.freemarker.core.model.TemplateModel;

/**
 * AST expression node: boolean literal 
 */
final class ASTExpBooleanLiteral extends ASTExpression {

    private final boolean val;

    public ASTExpBooleanLiteral(boolean val) {
        this.val = val;
    }

    static TemplateBooleanModel getTemplateModel(boolean b) {
        return b? TemplateBooleanModel.TRUE : TemplateBooleanModel.FALSE;
    }

    @Override
    boolean evalToBoolean(Environment env) {
        return val;
    }

    @Override
    public String getCanonicalForm() {
        return val ? TemplateBooleanFormat.C_TRUE : TemplateBooleanFormat.C_FALSE;
    }

    @Override
    public String getLabelWithoutParameters() {
        return getCanonicalForm();
    }
    
    @Override
    TemplateModel _eval(Environment env) {
        return val ? TemplateBooleanModel.TRUE : TemplateBooleanModel.FALSE;
    }
    
    @Override
    boolean isLiteral() {
        return true;
    }

    @Override
    ASTExpression deepCloneWithIdentifierReplaced_inner(
            String replacedIdentifier, ASTExpression replacement, ReplacemenetState replacementState) {
    	return new ASTExpBooleanLiteral(val);
    }
    
    @Override
    int getParameterCount() {
        return 0;
    }

    @Override
    Object getParameterValue(int idx) {
        throw new IndexOutOfBoundsException();
    }

    @Override
    ParameterRole getParameterRole(int idx) {
        throw new IndexOutOfBoundsException();
    }
    
}