to top
Android APIs
public class

Proxy

extends Object
java.lang.Object
   ↳ java.net.Proxy

Class Overview

This class represents proxy server settings. A created instance of Proxy stores a type and an address and is immutable. There are three types of proxies:

  • DIRECT
  • HTTP
  • SOCKS

Summary

Nested Classes
enum Proxy.Type Enum class for the proxy type. 
Fields
public static final Proxy NO_PROXY Represents the proxy type setting Proxy.Type.DIRECT.
Public Constructors
Proxy( Proxy.Type type, SocketAddress sa)
Creates a new Proxy instance.
Public Methods
SocketAddress address()
Gets the address of this Proxy instance.
final boolean equals( Object obj)
Compares the specified obj to this Proxy instance and returns whether they are equal or not.
final int hashCode()
Gets the hashcode for this Proxy instance.
String toString()
Gets a textual representation of this Proxy instance.
Proxy.Type type()
Gets the type of this Proxy instance.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final Proxy NO_PROXY

Added in API level 1

Represents the proxy type setting Proxy.Type.DIRECT. It tells protocol handlers that there is no proxy to be used. The address is set to null.

Public Constructors

public Proxy (Proxy.Type type, SocketAddress sa)

Added in API level 1

Creates a new Proxy instance. SocketAddress must NOT be null when type is either Proxy.Type.HTTP or Proxy.Type.SOCKS. To create a Proxy instance representing the proxy type Proxy.Type.DIRECT, use Proxy.NO_PROXY instead of this constructor.

Parameters
type the proxy type of this instance.
sa the proxy address of this instance.
Throws
IllegalArgumentException if the parameter type is set to Proxy.Type.DIRECT or the value for SocketAddress is null.

Public Methods

public SocketAddress address ()

Added in API level 1

Gets the address of this Proxy instance.

Returns
  • the stored proxy address or null if the proxy type is DIRECT.

public final boolean equals (Object obj)

Added in API level 1

Compares the specified obj to this Proxy instance and returns whether they are equal or not. The given object must be an instance of Proxy with the same address and the same type value to be equal.

Parameters
obj the object to compare with this instance.
Returns
  • true if the given object represents the same Proxy as this instance, false otherwise.
See Also

public final int hashCode ()

Added in API level 1

Gets the hashcode for this Proxy instance.

Returns
  • the hashcode value for this Proxy instance.

public String toString ()

Added in API level 1

Gets a textual representation of this Proxy instance. The string includes the two parts type.toString() and address.toString() if address is not null.

Returns
  • the representing string of this proxy.

public Proxy.Type type ()

Added in API level 1

Gets the type of this Proxy instance.

Returns
  • the stored proxy type.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.