Class MessageEmitter

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver, ReceiverWithOutputProperties

    public class MessageEmitter
    extends XMLEmitter
    MessageEmitter is the default Receiver for xsl:message output. It is the same as XMLEmitter except that (a) it adds an extra newline at the end of the message, and (b) it recognizes a processing-instruction with name "error-code" specially; this is assumed to contain the error-code requested on the xsl:message instruction. These changes can be overridden in a user-supplied subclass.
    • Constructor Detail

      • MessageEmitter

        public MessageEmitter()
    • Method Detail

      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                          java.lang.CharSequence data,
                                          Location locationId,
                                          int properties)
                                   throws XPathException
        Description copied from class: XMLEmitter
        Handle a processing instruction.
        Specified by:
        processingInstruction in interface Receiver
        processingInstruction in class XMLEmitter
        target - The PI name. This must be a legal name (it will not be checked).
        data - The data portion of the processing instruction
        locationId - provides information such as line number and system ID.
        properties - Additional information about the PI.
        XPathException - if an error occurs
      • suppressProcessingInstruction

        protected boolean suppressProcessingInstruction​(java.lang.String target,
                                                        java.lang.CharSequence data,
                                                        Location locationId,
                                                        int properties)
        Method to decide whether a processing instruction in the message should be suppressed. The default implementation suppresses a processing instruction whose target is "error-code"; this processing instruction is inserted into the message; its data part is an EQName containing the error code.
        target - the processing instruction target (that is, name)
        data - the data part of the processing instruction
        locationId - the location, which in the case of the error-code processing instruction, holds the location of the originating xsl:message instruction
        properties - currently 0.
        true if the processing instruction is to be suppressed from the displayed message.