org.thymeleaf.processor.processinginstruction

Interface IProcessingInstructionStructureHandler

All Known Implementing Classes:

ProcessingInstructionStructureHandler

public interface IProcessingInstructionStructureHandler

Structure handler class meant to be used by 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.

Since:

3.0.0

Author:

Daniel Fernández

See Also:

IProcessingInstructionProcessor

Method Summary

Modifier and Type	Method and Description
void	removeProcessingInstruction() Instructs the engine to remove the entire event that is being processed.
void	replaceWith(IModel model, boolean processable) Instructs the engine to replace the current event with the specified model (a IModel).
void	reset() Resets all actions specified so far for the current processor execution.
void	setProcessingInstruction(String target, String content) Instructs the engine to set new values into the properties of the ProcessingInstruction event being processed.

Method Detail

reset

void reset()

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

setProcessingInstruction

void setProcessingInstruction(String target,
                              String content)

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

Parameters:

target - the new target value

content - the new content value

replaceWith

void replaceWith(IModel model,
                 boolean processable)

Instructs the engine to replace the current event with the specified model (a IModel).

Parameters:

model - the model to be used as a replacement.

processable - whether the model should be considered processable or not.

removeProcessingInstruction

void removeProcessingInstruction()

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