Interface IXMLDeclarationStructureHandler
- All Known Implementing Classes:
XMLDeclarationStructureHandler
public interface IXMLDeclarationStructureHandler
Structure handler class meant to be used by IXMLDeclarationProcessor
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:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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 (aIModel
).void
reset()
Resets all actions specified so far for the current processor execution.void
setXMLDeclaration
(String keyword, String version, String encoding, String standalone) Instructs the engine to set new values into the properties of the XMLDeclaration event being processed.
-
Method Details
-
reset
void reset()Resets all actions specified so far for the current processor execution.
-
setXMLDeclaration
Instructs the engine to set new values into the properties of the XMLDeclaration event being processed.
- Parameters:
keyword
- the new keyword valueversion
- the new version value (might be null)encoding
- the new encoding value (might be null)standalone
- the new standalone value (might be null)
-
replaceWith
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.
-
removeXMLDeclaration
void removeXMLDeclaration()Instructs the engine to remove the entire event that is being processed.
-