Proxy (moe.ios.core API)

java.lang.Object
- java.net.Proxy

public class Proxy
extends Object

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Proxy.Type
Enum class for the proxy type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Proxy.Type` `Enum` class for the proxy type.

Field Summary

Fields
Modifier and Type Field and Description

static Proxy NO_PROXY
Represents the proxy type setting Proxy.Type.DIRECT.

Fields
Modifier and Type	Field and Description
`static Proxy`	`NO_PROXY` Represents the proxy type setting `Proxy.Type.DIRECT`.

Constructor Summary

Constructors
Constructor and Description

Proxy(Proxy.Type type, SocketAddress sa)
Creates a new Proxy instance.

Constructors
Constructor and Description
`Proxy(Proxy.Type type, SocketAddress sa)` Creates a new `Proxy` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SocketAddress`	`address()` Gets the address of this `Proxy` instance.
`boolean`	`equals(Object obj)` Compares the specified `obj` to this `Proxy` instance and returns whether they are equal or not.
`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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NO_PROXY
```
public static final Proxy NO_PROXY
```
    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.
- Constructor Detail
  - Proxy
```
public Proxy(Proxy.Type type,
             SocketAddress sa)
```
    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.
- Method Detail
  - type
```
public Proxy.Type type()
```
    Gets the type of this Proxy instance.
    
    Returns:
    
    the stored proxy type.
  - address
```
public SocketAddress address()
```
    Gets the address of this Proxy instance.
    
    Returns:
    
    the stored proxy address or null if the proxy type is DIRECT.
  - toString
```
public String toString()
```
    Gets a textual representation of this Proxy instance. The string includes the two parts type.toString() and address.toString() if address is not null.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the representing string of this proxy.
  - equals
```
public final boolean equals(Object obj)
```
    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.
    
    Overrides:
    
    equals in class Object
    
    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:
    
    hashCode()
  - hashCode
```
public final int hashCode()
```
    Gets the hashcode for this Proxy instance.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hashcode value for this Proxy instance.
    
    See Also:
    
    Object.equals(java.lang.Object)