de.malkusch.whoisServerList.publicSuffixList

Class PublicSuffixListFactory

java.lang.Object

de.malkusch.whoisServerList.publicSuffixList.PublicSuffixListFactory

@Immutable
public final class PublicSuffixListFactory
extends Object

The factory for PublicSuffixList.

Author:

markus@malkusch.de

See Also:

PublicSuffixList, Donations

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_CHARSET Character encoding of the list.
static String	PROPERTY_FILE Location of the default properties.
static String	PROPERTY_INDEX Deprecated. As of release 2.0.0, replaced by PROPERTY_INDEX_FACTORY.
static String	PROPERTY_INDEX_FACTORY Index factory.
static String	PROPERTY_LIST_FILE The factory will load the Public Suffix List from this file.
static String	PROPERTY_URL URL of the Public Suffix List.

Constructor Summary

Constructors

Constructor and Description
PublicSuffixListFactory()

Method Summary

Modifier and Type	Method and Description
PublicSuffixList	build() Builds a PublicSuffixList with the default properties.
PublicSuffixList	build(InputStream list) Builds a PublicSuffixList.
PublicSuffixList	build(Properties properties) Builds a PublicSuffixList with custom properties.
PublicSuffixList	download() Downloads the public suffix list.
Properties	getDefaults() Gets the bundled default properties.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_URL

public static final String PROPERTY_URL

URL of the Public Suffix List.

See Also:

PublicSuffixList.getURL(), Constant Field Values

PROPERTY_CHARSET

public static final String PROPERTY_CHARSET

Character encoding of the list.

See Also:

PublicSuffixList.getCharset(), Constant Field Values

PROPERTY_LIST_FILE

public static final String PROPERTY_LIST_FILE

The factory will load the Public Suffix List from this file.

See Also:

Constant Field Values

PROPERTY_INDEX

@Deprecated
public static final String PROPERTY_INDEX

Deprecated. As of release 2.0.0, replaced by PROPERTY_INDEX_FACTORY.

Index implementation.

See Also:

Constant Field Values

PROPERTY_INDEX_FACTORY

public static final String PROPERTY_INDEX_FACTORY

Index factory.

Since:

2.0.0

See Also:

IndexFactory, Constant Field Values

PROPERTY_FILE

public static final String PROPERTY_FILE

Location of the default properties.

See Also:

build(), Constant Field Values

Constructor Detail

PublicSuffixListFactory

public PublicSuffixListFactory()

Method Detail

getDefaults

public Properties getDefaults()

Gets the bundled default properties. The default properties are included in the jar file at /psl.properties. It refers to the bundled Public Suffix List file and uses a TreeIndexFactory.

Returns:

the default properties

build

public PublicSuffixList build(Properties properties)
                       throws IOException,
                              ClassNotFoundException

Builds a PublicSuffixList with custom properties. It is a good idea to load the default properties and overwrite keys as required.

Parameters:

properties - the properties for building the PublicSuffixList.

Returns:

a public suffix list build with the properties

Throws:

ClassNotFoundException - If the property PROPERTY_INDEX_FACTORY is not a IndexFactory implementation

IOException - If the property PROPERTY_LIST_FILE can't be read as a file

See Also:

getDefaults()

build

public PublicSuffixList build(InputStream list)
                       throws IOException

Builds a PublicSuffixList.

Parameters:

list - The list.

Returns:

a public suffix list

Throws:

IOException - If the list can't be read as a file

download

public PublicSuffixList download()
                          throws IOException

Downloads the public suffix list.

Returns:

a public suffix list

Throws:

IOException - If the list can't be downloaded.

build

public PublicSuffixList build()

Builds a PublicSuffixList with the default properties.

Returns:

a public suffix list build with the default properties

See Also:

PROPERTY_FILE, getDefaults()