org.thymeleaf.processor.element.AbstractLocalVariableDefinitionElementProcessor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of thymeleaf Show documentation

XML/XHTML/HTML5 template engine for Java

There is a newer version: 3.1.2.RELEASE

/*
 * =============================================================================
 * 
 *   Copyright (c) 2011-2014, The THYMELEAF team (http://www.thymeleaf.org)
 * 
 *   Licensed 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.thymeleaf.processor.element;

import java.util.Map;

import org.thymeleaf.Arguments;
import org.thymeleaf.dom.Element;
import org.thymeleaf.exceptions.TemplateProcessingException;
import org.thymeleaf.processor.IElementNameProcessorMatcher;
import org.thymeleaf.processor.ProcessorResult;

/**
 * 
 * @author Daniel Fernández
 * 
 * @since 1.0
 *
 */
public abstract class AbstractLocalVariableDefinitionElementProcessor 
        extends AbstractElementProcessor {




    protected AbstractLocalVariableDefinitionElementProcessor(final String elementName) {
        super(elementName);
    }

    protected AbstractLocalVariableDefinitionElementProcessor(final IElementNameProcessorMatcher matcher) {
        super(matcher);
    }


    
    
    
    
    @Override
    public final ProcessorResult processElement(final Arguments arguments, final Element element) {
        
        final boolean removeHostElement = 
                removeHostElement(arguments, element);
        
        final Map newLocalVariables = 
                getNewLocalVariables(arguments, element);
        
        if (newLocalVariables == null) {
            throw new TemplateProcessingException("Null variables map for \"" +
                    element.getOriginalName() + "\" element not allowed");
        }
        
        if (removeHostElement) {
            element.getParent().extractChild(element);
        }
        
        return ProcessorResult.setLocalVariables(newLocalVariables);
        
    }
    
    
    
    protected abstract Map getNewLocalVariables(final Arguments arguments, final Element element);
    
 
    
    protected abstract boolean removeHostElement(final Arguments arguments, final Element element);
    
    
}