Class HTMLURIEscaper

All Implemented Interfaces:
Result, Receiver
Direct Known Subclasses:
XHTMLURIEscaper

public class HTMLURIEscaper extends ProxyReceiver
This class is used as a filter on the serialization pipeline; it performs the function of escaping URI-valued attributes in HTML
Author:
Michael H. Kay
  • Field Details

    • currentElement

      protected NodeName currentElement
    • escapeURIAttributes

      protected boolean escapeURIAttributes
    • pool

      protected NamePool pool
  • Constructor Details

    • HTMLURIEscaper

      public HTMLURIEscaper(Receiver nextReceiver)
  • Method Details

    • isUrlAttribute

      public boolean isUrlAttribute(NodeName element, NodeName attribute)
    • startDocument

      public void startDocument(int properties) throws XPathException
      Start of a document node.
      Specified by:
      startDocument in interface Receiver
      Overrides:
      startDocument in class ProxyReceiver
      Parameters:
      properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions
      Throws:
      XPathException - if an error occurs
    • startElement

      public void startElement(NodeName nameCode, SchemaType typeCode, int locationId, int properties) throws XPathException
      Notify the start of an element
      Specified by:
      startElement in interface Receiver
      Overrides:
      startElement in class ProxyReceiver
      Parameters:
      nameCode - integer code identifying the name of the element within the name pool.
      typeCode - integer code identifying the element's type within the name pool.
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - properties of the element node
      Throws:
      XPathException - if an error occurs
    • attribute

      public void attribute(NodeName nameCode, SimpleType typeCode, CharSequence value, int locationId, int properties) throws XPathException
      Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.
      Specified by:
      attribute in interface Receiver
      Overrides:
      attribute in class ProxyReceiver
      Parameters:
      nameCode - The name of the attribute, as held in the name pool
      typeCode - The type of the attribute, as held in the name pool
      value - the string value of the attribute
      locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.
      properties - Bit significant value. The following bits are defined:
      DISABLE_ESCAPING
      Disable escaping for this attribute
      NO_SPECIAL_CHARACTERS
      Attribute value contains no special characters
      Throws:
      XPathException - if an error occurs
    • escapeURL

      public static CharSequence escapeURL(CharSequence url, boolean normalize, Configuration config) throws XPathException
      Escape a URI according to the HTML rules: that is, a non-ASCII character (specifically, a character outside the range 32 - 126) is replaced by the %HH encoding of the octets in its UTF-8 representation
      Parameters:
      url - the URI to be escaped
      normalize -
      Returns:
      the URI after escaping non-ASCII characters
      Throws:
      XPathException