Package org.apache.commons.configuration2.io

Class URLConnectionOptions

java.lang.Object

org.apache.commons.configuration2.io.URLConnectionOptions

public final class URLConnectionOptions
extends java.lang.Object

Carries options and operates on URLConnection.

Since:

2.8.0

Field Summary

Fields

Modifier and Type	Field	Description
static URLConnectionOptions	DEFAULT	Default options.

Constructor Summary

Constructors

Constructor	Description
URLConnectionOptions()	Constructs a new default instance.
URLConnectionOptions(URLConnectionOptions urlConnectionOptions)	Constructs an instance with values from the given URLConnectionOptions.

Method Summary

Modifier and Type	Method	Description
java.net.URLConnection	apply(java.net.URLConnection urlConnection)	Applies the options to the given connection.
boolean	equals(java.lang.Object obj)
boolean	getAllowUserInteraction()	Gets whether to allow user interaction.
int	getConnectTimeoutMillis()	Gets the connect timeout.
int	getReadTimeoutMillis()	Gets the read timeout.
boolean	getUseCaches()	Whether to cache.
int	hashCode()
java.net.URLConnection	openConnection(java.net.URL url)	Opens a connection for the given URL with our options.
URLConnectionOptions	setAllowUserInteraction(boolean allowUserInteraction)
URLConnectionOptions	setConnectTimeoutMillis(int connectTimeoutMillis)
URLConnectionOptions	setReadTimeoutMillis(int readTimeoutMillis)
URLConnectionOptions	setUseCaches(boolean useCaches)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final URLConnectionOptions DEFAULT

Default options.

Constructor Detail

URLConnectionOptions

public URLConnectionOptions()

Constructs a new default instance.

URLConnectionOptions

public URLConnectionOptions(URLConnectionOptions urlConnectionOptions)

Constructs an instance with values from the given URLConnectionOptions.

Parameters:

urlConnectionOptions - the source

Method Detail

apply

public java.net.URLConnection apply(java.net.URLConnection urlConnection)

Applies the options to the given connection.

Parameters:

urlConnection - the target connection.

Returns:

the given connection.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAllowUserInteraction

public boolean getAllowUserInteraction()

Gets whether to allow user interaction.

Returns:

whether to allow user interaction.

getConnectTimeoutMillis

public int getConnectTimeoutMillis()

Gets the connect timeout.

Returns:

the connect timeout.

getReadTimeoutMillis

public int getReadTimeoutMillis()

Gets the read timeout.

Returns:

the read timeout.

getUseCaches

public boolean getUseCaches()

Whether to cache.

Returns:

Whether to cache.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

openConnection

public java.net.URLConnection openConnection(java.net.URL url)
                                      throws java.io.IOException

Opens a connection for the given URL with our options.

Parameters:

url - the URL to open

Returns:

A new connection

Throws:

java.io.IOException - if an I/O exception occurs.

setAllowUserInteraction

public URLConnectionOptions setAllowUserInteraction(boolean allowUserInteraction)

setConnectTimeoutMillis

public URLConnectionOptions setConnectTimeoutMillis(int connectTimeoutMillis)

setReadTimeoutMillis

public URLConnectionOptions setReadTimeoutMillis(int readTimeoutMillis)

setUseCaches

public URLConnectionOptions setUseCaches(boolean useCaches)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object