base.py 694 Bytes
Newer Older
1

2 3 4 5 6
# slixmpp.xmlstream.matcher.base
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Part of Slixmpp: The Slick XMPP Library
# :copyright: (c) 2011 Nathanael C. Fritz
# :license: MIT, see LICENSE for more details
7

Nathan Fritz's avatar
Nathan Fritz committed
8 9
class MatcherBase(object):

10 11 12 13
    """
    Base class for stanza matchers. Stanza matchers are used to pick
    stanzas out of the XML stream and pass them to the appropriate
    stream handlers.
14 15

    :param criteria: Object to compare some aspect of a stanza against.
16 17 18 19 20 21
    """

    def __init__(self, criteria):
        self._criteria = criteria

    def match(self, xml):
22
        """Check if a stanza matches the stored criteria.
23 24 25 26

        Meant to be overridden.
        """
        return False