de.malkusch.whoisServerList.publicSuffixList.rule

Class Rule

java.lang.Object

de.malkusch.whoisServerList.publicSuffixList.rule.Rule

@Immutable
public final class Rule
extends Object

The Public Suffix rule.

Author:

markus@malkusch.de

See Also:

Donations

Field Summary

Fields

Modifier and Type	Field and Description
static Rule	DEFAULT The default rule ("*").
static char	EXCEPTION_TOKEN The exception token.
static String	WILDCARD The wildcard label.

Constructor Summary

Constructors

Constructor and Description
Rule(String pattern) Initializes a normal rule.
Rule(String pattern, boolean exceptionRule) Initializes a rule.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getLabelCount() Returns the label count of this rule.
String	getPattern() Returns the rule pattern.
int	hashCode()
boolean	isExceptionRule() Returns if this rule is an exception rule.
String	match(String domain) Returns the matched public suffix of a domain.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EXCEPTION_TOKEN

public static final char EXCEPTION_TOKEN

The exception token. An exception rule begins with "!".

See Also:

Constant Field Values

WILDCARD

public static final String WILDCARD

The wildcard label.

See Also:

Constant Field Values

DEFAULT

public static final Rule DEFAULT

The default rule ("*"). This rule applies if no other rule did match.

Constructor Detail

Rule

public Rule(String pattern)

Initializes a normal rule. The pattern has no more exception token!

Parameters:

pattern - the rule matching pattern, not null

Rule

public Rule(String pattern,
    boolean exceptionRule)

Initializes a rule. The pattern has no more exception token!

Parameters:

pattern - the rule matching pattern, not null

exceptionRule - whether this is an exception rule

Method Detail

getLabelCount

public int getLabelCount()

Returns the label count of this rule. The label count is used for determining the prevailing rule.

Returns:

the label count

See Also:

RuleComparator, Index.findRule(String)

getPattern

public String getPattern()

Returns the rule pattern. The exception token is not included in the pattern!

Returns:

the rule pattern, not null.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isExceptionRule

public boolean isExceptionRule()

Returns if this rule is an exception rule. Exception rules are always prevailing rules.

Returns:

true if this is an exception rule

match

public String match(String domain)

Returns the matched public suffix of a domain.

Parameters:

domain - the domain name, may be null

Returns:

the public suffix for the domain name, or null if no match