Interface IDocTypeStructureHandler

  • All Known Implementing Classes:
    DocTypeStructureHandler

    public interface IDocTypeStructureHandler

    Structure handler class meant to be used by IDocTypeProcessor 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:
    IDocTypeProcessor
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void removeDocType()
      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 setDocType​(String keyword, String elementName, String publicId, String systemId, String internalSubset)
      Instructs the engine to set new values into the properties of the DocType event being processed.
    • Method Detail

      • reset

        void reset()

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

      • setDocType

        void setDocType​(String keyword,
                        String elementName,
                        String publicId,
                        String systemId,
                        String internalSubset)

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

        Parameters:
        keyword - the new keyword value
        elementName - the new elementName value
        publicId - the new PUBLIC ID (might be null)
        systemId - the new SYSTEM ID (might be null)
        internalSubset - the new internal subset (might be null)
      • 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.
      • removeDocType

        void removeDocType()

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