Class ActiveFilter

Extends Filter.

Defined in: FilterClasses.jsm.

Class Summary
Constructor Attributes	Constructor Name and Description
	ActiveFilter(text, domains) Abstract base class for filters that can get hits

Field Summary
Field Attributes	Field Name and Description
	disabled Defines whether the filter is disabled
	domains Map containing domains that this filter should match on/not match on or null if the filter should match on all domains
	domainSeparator Separator character used in domainSource property, must be overridden by subclasses
	domainSource String that the domains property should be generated from
	hitCount Number of hits on the filter since the last reset
	lastHit Last time the filter had a hit (in milliseconds since the beginning of the epoch)

Method Summary
Method Attributes	Method Name and Description
<private>	_generateDomains() Generates domains property when it is requested for the first time.
<private>	_getDomains() Called first time domains property is requested, triggers _generateDomains method.
	isActiveOnDomain(docDomain) Checks whether this filter is active on a domain.
	isActiveOnlyOnDomain(docDomain) Checks whether this filter is active only on a domain and its subdomains.
	serialize(buffer) See Filter.serialize()

Class Detail

ActiveFilter(text, domains)

Abstract base class for filters that can get hits

Parameters:
{String} text: see Filter()
{String} domains: (optional) Domains that the filter is restricted to separated by domainSeparator e.g. "foo.com|bar.com|~baz.com"

Field Detail

{Boolean} disabled

Defines whether the filter is disabled

{Object} domains

Map containing domains that this filter should match on/not match on or null if the filter should match on all domains

{String} domainSeparator

Separator character used in domainSource property, must be overridden by subclasses

{String} domainSource

String that the domains property should be generated from

{Number} hitCount

Number of hits on the filter since the last reset

{Number} lastHit

Last time the filter had a hit (in milliseconds since the beginning of the epoch)

Method Detail

<private> _generateDomains()

Generates domains property when it is requested for the first time.

<private> _getDomains()

Called first time domains property is requested, triggers _generateDomains method.

{Boolean} isActiveOnDomain(docDomain)

Checks whether this filter is active on a domain.

{Boolean} isActiveOnlyOnDomain(docDomain)

Checks whether this filter is active only on a domain and its subdomains.

serialize(buffer)

See Filter.serialize()