All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.thymeleaf.processor.processinginstruction.IProcessingInstructionStructureHandler Maven / Gradle / Ivy

Go to download

Modern server-side Java template engine for both web and standalone environments

There is a newer version: 3.1.2.RELEASE
Show newest version
/*
 * =============================================================================
 *
 *   Copyright (c) 2011-2018, 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.processinginstruction;

import org.thymeleaf.model.IModel;

/**
 * 

* Structure handler class meant to be used by {@link IProcessingInstructionProcessor} implementations. *

*

* Structure handlers allow processors to instruct the engine to perform a series of actions that cannot * be done directly from the processors themselves, usually because these actions are applied or have effects * on scopes broader than the processed events themselves. *

* * @author Daniel Fernández * @see IProcessingInstructionProcessor * @since 3.0.0 * */ public interface IProcessingInstructionStructureHandler { /** *

* Resets all actions specified so far for the current processor execution. *

*/ public void reset(); /** *

* Instructs the engine to set new values into the properties of the ProcessingInstruction event being processed. *

* * @param target the new target value * @param content the new content value */ public void setProcessingInstruction(final String target, final String content); /** *

* Instructs the engine to replace the current event with the specified model (a {@link IModel}). *

* * @param model the model to be used as a replacement. * @param processable whether the model should be considered processable or not. */ public void replaceWith(final IModel model, final boolean processable); /** *

* Instructs the engine to remove the entire event that is being processed. *

*/ public void removeProcessingInstruction(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy