org.thymeleaf.processor.attr.AbstractSelectionTargetAttrProcessor Maven / Gradle / Ivy

Go to download
/*
 * =============================================================================
 * 
 *   Copyright (c) 2011-2012, 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.attr;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import org.thymeleaf.Arguments;
import org.thymeleaf.dom.Element;
import org.thymeleaf.processor.IAttributeNameProcessorMatcher;
import org.thymeleaf.processor.ProcessorResult;

/**
 * 
 * @author Daniel Fernández
 * 
 * @since 1.0
 *
 */
public abstract class AbstractSelectionTargetAttrProcessor 
        extends AbstractAttrProcessor {
    
    
    
    
    
    protected AbstractSelectionTargetAttrProcessor(final String attributeName) {
        super(attributeName);
    }
    
    
    protected AbstractSelectionTargetAttrProcessor(final IAttributeNameProcessorMatcher matcher) {
        super(matcher);
    }

    

    
    
    @Override
    public final ProcessorResult processAttribute(final Arguments arguments, final Element element, final String attributeName) {

        final Object newSelectionTarget = 
            getNewSelectionTarget(arguments, element, attributeName);
        
        Map additionalLocalVariables = 
            getAdditionalLocalVariables(arguments, element, attributeName);
        
        if (additionalLocalVariables == null) {
            additionalLocalVariables = new HashMap(2, 1.0f);
        } else {
            additionalLocalVariables = new HashMap(additionalLocalVariables);
        }
        
        doAdditionalProcess(arguments, element, attributeName);
        
        element.removeAttribute(attributeName);
        
        return ProcessorResult.setLocalVariablesAndSelectionTarget(additionalLocalVariables, newSelectionTarget);
        
    }
    
    
    @SuppressWarnings("unused")
    protected Map getAdditionalLocalVariables(
            final Arguments arguments, final Element element, final String attributeName) {
        // This method is meant to be overriden. By default, no local variables
        // will be set.
        return Collections.emptyMap();
    }

    
    
    protected abstract Object getNewSelectionTarget(
            final Arguments arguments, final Element element, final String attributeName);

    
    
    @SuppressWarnings("unused")
    protected void doAdditionalProcess(
            final Arguments arguments, final Element element, final String attributeName) {
        // Nothing to be done, meant to be overriden
    }
    
    
}