freemarker-core/src/main/java/org/apache/freemarker/core/ASTDirAttemptRecoverContainer.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 java.io.IOException;

/**
 * AST directive node: Holder for the attempted section of the {@code #attempt} element and of the nested
 * {@code #recover} element ({@link ASTDirRecover}).
 */
final class ASTDirAttemptRecoverContainer extends ASTDirective {
    
    private ASTElement attemptedSection;
    private ASTDirRecover recoverySection;
    
    ASTDirAttemptRecoverContainer(TemplateElements attemptedSectionChildren, ASTDirRecover recoverySection) {
        ASTElement attemptedSection = attemptedSectionChildren.asSingleElement();
        this.attemptedSection = attemptedSection;
        this.recoverySection = recoverySection;
        setChildBufferCapacity(2);
        addChild(attemptedSection); // for backward compatibility
        addChild(recoverySection);
    }

    @Override
    ASTElement[] execute(Environment env) throws TemplateException, IOException {
        env.visitAttemptRecover(this, attemptedSection, recoverySection);
        return null;
    }

    @Override
    String dump(boolean canonical) {
        if (!canonical) {
            return getLabelWithoutParameters();
        } else {
            StringBuilder buf = new StringBuilder();
            buf.append("<").append(getLabelWithoutParameters()).append(">");
            buf.append(getChildrenCanonicalForm());            
            buf.append("</").append(getLabelWithoutParameters()).append(">");
            return buf.toString();
        }
    }
    
    @Override
    int getParameterCount() {
        return 1;
    }

    @Override
    Object getParameterValue(int idx) {
        if (idx != 0) throw new IndexOutOfBoundsException();
        return recoverySection;
    }

    @Override
    ParameterRole getParameterRole(int idx) {
        if (idx != 0) throw new IndexOutOfBoundsException();
        return ParameterRole.ERROR_HANDLER;
    }
    
    @Override
    public String getLabelWithoutParameters() {
        return "#attempt";
    }
    
    @Override
    boolean isNestedBlockRepeater() {
        return false;
    }
    
}