de.malkusch.whoisServerList.publicSuffixList.index

Class Index

java.lang.Object

de.malkusch.whoisServerList.publicSuffixList.index.Index

@ThreadSafe
public abstract class Index
extends Object

Rule index. The PublicSuffixListFactory builds the PublicSuffixList with the index defined with the property PublicSuffixListFactory.PROPERTY_INDEX. Index implementations must be thread-safe.

Author:

markus@malkusch.de

See Also:

Donations

Constructor Summary

Constructors

Constructor and Description
Index()

Method Summary

Modifier and Type	Method and Description
Rule	findRule(String domain) Finds the prevailing rule.
protected abstract Collection<Rule>	findRules(String domain) Finds a list of matching rules.
abstract List<Rule>	getRules() Returns all rules of this index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Index

public Index()

Method Detail

findRules

protected abstract Collection<Rule> findRules(String domain)

Finds a list of matching rules. This list may not include all matching rules, but must include the prevailing rule.

Parameters:

domain - the domain name, may be null

Returns:

the list of matching rules, not null.

getRules

public abstract List<Rule> getRules()

Returns all rules of this index.

Returns:

the rules, not null

findRule

public final Rule findRule(String domain)

Finds the prevailing rule.

Parameters:

domain - the domain name, null returns null

Returns:

the prevailing rule, null if no rule matches