SleekXMPP/sleekxmpp/xmlstream/matcher/base.py
2011-12-04 16:26:14 -08:00

31 lines
742 B
Python

# -*- 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