summaryrefslogtreecommitdiff
path: root/sleekxmpp/xmlstream/matcher/base.py
blob: 83c266882a7d54cc735a4439f1dd852b8a252f61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# -*- coding: utf-8 -*-
"""
    sleekxmpp.xmlstream.matcher.base
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    Part of SleekXMPP: The Sleek XMPP Library

    :copyright: (c) 2011 Nathanael C. Fritz
    :license: MIT, see LICENSE for more details
"""


class MatcherBase(object):

    """
    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.

    :param criteria: Object to compare some aspect of a stanza against.
    """

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

    def match(self, xml):
        """Check if a stanza matches the stored criteria.

        Meant to be overridden.
        """
        return False