Class CharacterMapIndex

  • All Implemented Interfaces:

    public class CharacterMapIndex
    extends java.lang.Object
    implements java.lang.Iterable<CharacterMap>
    This class represents a set of named character maps. Each character map in the set is identified by a unique QName.
    • Constructor Detail

      • CharacterMapIndex

        public CharacterMapIndex()
    • Method Detail

      • getCharacterMap

        public CharacterMap getCharacterMap​(StructuredQName name)
        Get the character map with a given name
        name - the name of the required character map
        the requested character map if present, or null otherwise
      • putCharacterMap

        public void putCharacterMap​(StructuredQName name,
                                    CharacterMap charMap)
        Add a character map with a given name
        name - the name of the character map
        charMap - the character map to be added
      • iterator

        public java.util.Iterator<CharacterMap> iterator()
        Get an iterator over all the character maps in the index
        Specified by:
        iterator in interface java.lang.Iterable<CharacterMap>
        an iterator over the character maps
      • isEmpty

        public boolean isEmpty()
        Ask if the character map index is empty
        true if the character map index contains no character maps
      • copy

        public CharacterMapIndex copy()
        Copy this character map index
        a new character map index with the same contents. The character maps themselves are immutable and do not need to be copied
      • makeCharacterMapExpander

        public CharacterMapExpander makeCharacterMapExpander​(java.lang.String useMaps,
                                                             Receiver next,
                                                             SerializerFactory sf)
                                                      throws XPathException
        Make a CharacterMapExpander to handle the character map definitions in the serialization properties.

        This method is intended for internal use only.

        useMaps - the expanded use-character-maps property: a space-separated list of names of character maps to be used, each one expressed as an expanded-QName in Clark notation (that is, {uri}local-name).
        next - the next receiver in the pipeline
        sf - the SerializerFactory - used to create a CharacterMapExpander. This callback is provided so that a user-defined SerializerFactory can customize the result of this function, for example by returning a subclass of the standard CharacterMapExpander.
        a CharacterMapExpander if one is required, or null if not (for example, if the useMaps argument is an empty string).
        XPathException - if a name in the useMaps property cannot be resolved to a declared character map.