org.thymeleaf.processor.ProcessorResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thymeleaf Show documentation
Modern server-side Java template engine for both web and standalone environments
There is a newer version: 3.1.3.RELEASE
/*
 * =============================================================================
 * 
 *   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;

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

import org.thymeleaf.Arguments;


/**
 * 
 * @author Daniel Fernández
 * 
 * @since 2.0.0
 *
 */
public final class ProcessorResult {

    private static final Map EMPTY_VARIABLES = Collections.unmodifiableMap(new HashMap());

    
    public static final ProcessorResult OK = new ProcessorResult(null, false, false, null, false);
    
    private final Map localVariables;
    private final boolean processOnlyElementNodes;
    private final boolean processOnlyElementNodesSet;
    private final Object selectionTarget;
    private final boolean selectionTargetSet;

    
    
    public static ProcessorResult ok() {
        return OK;
    }
    
    public static ProcessorResult setLocalVariables(final Map localVariables) {
        return new ProcessorResult(localVariables, false, false, null, false);
    }
    
    public static ProcessorResult setProcessOnlyElementNodes(final boolean processOnlyElementNodes) {
        return new ProcessorResult(null, processOnlyElementNodes, true, null, false);
    }
    
    public static ProcessorResult setLocalVariablesAndProcessOnlyElementNodes(final Map localVariables, final boolean processOnlyElementNodes) {
        return new ProcessorResult(localVariables, processOnlyElementNodes, true, null, false);
    }

    /**
     * @since 2.0.9
     */
    public static ProcessorResult setSelectionTarget(final Object selectionTarget) {
        return new ProcessorResult(null, false, false, selectionTarget, true);
    }

    /**
     * @since 2.0.9
     */
    public static ProcessorResult setLocalVariablesAndSelectionTarget(
            final Map localVariables, final Object selectionTarget) {
        return new ProcessorResult(localVariables, false, false, selectionTarget, true);
    }


    
    
    private ProcessorResult(
            final Map localVariables,
            final boolean processOnlyElementNodes,
            final boolean processOnlyElementNodesSet,
            final Object selectionTarget,
            final boolean selectionTargetSet) {
        super();
        this.localVariables =
            (localVariables == null?
                    EMPTY_VARIABLES :
                    Collections.unmodifiableMap(new HashMap(localVariables)));
        this.processOnlyElementNodes = processOnlyElementNodes;
        this.processOnlyElementNodesSet = processOnlyElementNodesSet;
        this.selectionTarget = selectionTarget;
        this.selectionTargetSet = selectionTargetSet;
    }

    
    
    public boolean hasLocalVariables() {
        return (this.localVariables != null && this.localVariables.size() > 0);
    }

    public Map getLocalVariables() {
        return this.localVariables;
    }
    
    public boolean getProcessOnlyElementNodes() {
        return this.processOnlyElementNodes;
    }
    
    public boolean isProcessOnlyElementNodesSet() {
        return this.processOnlyElementNodesSet;
    }
    
    /**
     * @since 2.0.9
     */
    public Object getSelectionTarget() {
        return this.selectionTarget;
    }
    
    /**
     * @since 2.0.9
     */
    public boolean isSelectionTargetSet() {
        return this.selectionTargetSet;
    }

    
    public boolean isOK() {
        return (this.localVariables == null || this.localVariables.size() == 0) &&
               !this.processOnlyElementNodesSet; 
    }
    

    
    
    
    public Arguments computeNewArguments(final Arguments arguments) {
        
        if (isOK()) {
            return arguments;
        }
        
        if (this.localVariables != null && this.localVariables.size() > 0) {
            // There are local variables
            if (this.processOnlyElementNodesSet) {
                // A text inliner has been set
                return arguments.addLocalVariablesAndProcessOnlyElementNodes(this.localVariables, this.processOnlyElementNodes);
            }
            if (this.selectionTargetSet) {
                return arguments.addLocalVariablesAndSelectionTarget(this.localVariables, this.selectionTarget);
            }
            // A text inliner has not been set
            return arguments.addLocalVariables(this.localVariables);
        }
        // There are no local variables
        if (this.processOnlyElementNodesSet) {
            // A text inliner has been set
            return arguments.setProcessOnlyElementNodes(this.processOnlyElementNodes);
        }
        // There are no local variables
        if (this.selectionTargetSet) {
            // A text inliner has been set
            return arguments.setSelectionTarget(this.selectionTarget);
        }
        // A text inliner has not been set
        return arguments;
        
    }
    
}