de.malkusch.whoisServerList.publicSuffixList

Class PublicSuffixList

java.lang.Object

de.malkusch.whoisServerList.publicSuffixList.PublicSuffixList

@Immutable
public final class PublicSuffixList
extends Object

API for the Public Suffix List. Use PublicSuffixListFactory for building this api. You can use the API's methods with UTF-8 domain names or Punycode encoded ASCII domain names. The API will return the results in the same format as the input was. I.e. if you use an UTF-8 string the result will be an UTF-8 String as well. Same for Punycode. The API is case insensitive.

Author:

markus@malkusch.de

See Also:

PublicSuffixListFactory, https://publicsuffix.org/, Donations

Method Summary

Modifier and Type	Method and Description
Charset	getCharset() Returns the character encoding of the public suffix list.
String	getPublicSuffix(String domain) Returns the public suffix from a domain.
String	getRegistrableDomain(String domain) Gets the registrable domain.
List<Rule>	getRules() Returns a list with all rules.
URL	getURL() Returns the URL of the public suffix list.
boolean	isPublicSuffix(String domain) Returns whether a domain is a public suffix or not.
boolean	isRegistrable(String domain) Returns whether a domain is registrable.

Methods inherited from class java.lang.Object

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

Method Detail

getRegistrableDomain

public String getRegistrableDomain(String domain)

Gets the registrable domain. E.g. "www.example.net" and "example.net" will return "example.net". Null, an empty string or domains with a leading dot will return null. This method is case insensitive.

Parameters:

domain - the domain name, null returns null

Returns:

the registrable domain, null if the domain is not registrable at all

isRegistrable

public boolean isRegistrable(String domain)

Returns whether a domain is registrable. E.g. example.net is registrable, "www.example.net" and "net" are not. This method is case insensitive.

Parameters:

domain - the domain name, not null

Returns:

true if the domain is registrable

getPublicSuffix

public String getPublicSuffix(String domain)

Returns the public suffix from a domain. If the domain is already a public suffix, it will be returned unchanged. E.g. "www.example.net" will return "net". This method is case insensitive.

Parameters:

domain - the domain name

Returns:

the public suffix, null if none matched

isPublicSuffix

public boolean isPublicSuffix(String domain)

Returns whether a domain is a public suffix or not. Example: "com" is a public suffix, "example.com" isn't. This method is case insensitive.

Parameters:

domain - the domain name, not null

Returns:

true if the domain is a public suffix

getCharset

public Charset getCharset()

Returns the character encoding of the public suffix list.

Returns:

the character encoding

getURL

public URL getURL()

Returns the URL of the public suffix list.

Returns:

the URL

getRules

public List<Rule> getRules()

Returns a list with all rules.

Returns:

the rule list