com.screenscraper.http

Enum ScrapingHttpClientType

java.lang.Object

java.lang.Enum<ScrapingHttpClientType>

com.screenscraper.http.ScrapingHttpClientType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ScrapingHttpClientType>

public enum ScrapingHttpClientType
extends java.lang.Enum<ScrapingHttpClientType>

Enumeration of the types of HTTP clients built into screen-scraper.

Version:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ApacheHttpClient4 Apache Http Client 4
AsyncHttpClient2 Async Http Client version 2
CurlHttpClient Async Http Client version 2
NingAsyncHttpClient Ning Async Http Client

Method Summary

Modifier and Type	Method and Description
static ScrapingHttpClientType	fromString(java.lang.String text) Converts a string to the actual object
static ScrapingHttpClientType	getDefaultClientType() Returns the default client type to use for scraping
java.lang.String	getDisplayName() Returns the DisplayName for the object
abstract ScrapingHttpClient	prepareNewClient(ScrapingSession session) Prepares the new scraping client, using the given session.
java.lang.String	toString()
static ScrapingHttpClientType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScrapingHttpClientType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ApacheHttpClient4

public static final ScrapingHttpClientType ApacheHttpClient4

Apache Http Client 4

NingAsyncHttpClient

public static final ScrapingHttpClientType NingAsyncHttpClient

Ning Async Http Client

AsyncHttpClient2

public static final ScrapingHttpClientType AsyncHttpClient2

Async Http Client version 2

CurlHttpClient

public static final ScrapingHttpClientType CurlHttpClient

Async Http Client version 2

Method Detail

values

public static ScrapingHttpClientType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScrapingHttpClientType c : ScrapingHttpClientType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScrapingHttpClientType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDefaultClientType

@NotNull
public static ScrapingHttpClientType getDefaultClientType()

Returns the default client type to use for scraping

Returns:

The default client type to use for scraping

prepareNewClient

public abstract ScrapingHttpClient prepareNewClient(@NotNull
                                                    ScrapingSession session)

Prepares the new scraping client, using the given session.

Parameters:

session - The session this client will be used for

Returns:

The client which makes use of the given session

Throws:

java.lang.IllegalStateException - If there is an error preparing the client. Assuming a normal install with all files in the correct places, this should never happen

getDisplayName

@NotNull
public java.lang.String getDisplayName()

Returns the DisplayName for the object

Returns:

The DisplayName for the object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<ScrapingHttpClientType>

fromString

@Nullable
public static ScrapingHttpClientType fromString(@NotNull
                                                           java.lang.String text)

Converts a string to the actual object

Parameters:

text - The text to convert back to a client type

Returns:

The type object, or null if there was no match