Apache HttpCore 4.4.16 · org.apache.http.HttpHost

Modifier and Type	Field and Description
protected final InetAddress	address
public static final String	DEFAULT_SCHEME_NAME The default scheme is "http".
protected final String	hostname The host to use.
protected final String	lcHostname The lowercase host, for `equals` and `hashCode`.
protected final int	port The port to use, defaults to -1 if not set.
protected final String	schemeName The scheme (lowercased)
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	HttpHost(final String the hostname (IP or DNS name) hostname, final int the port number. `-1` indicates the scheme default port. port, final String the name of the scheme. `null` indicates the `default scheme` scheme) Creates `HttpHost` instance with the given scheme, hostname and port.
public	HttpHost(final String the hostname (IP or DNS name) hostname, final int the port number. `-1` indicates the scheme default port. port) Creates `HttpHost` instance with the default scheme and the given hostname and port.
public	HttpHost(final String the hostname (IP or DNS name) hostname) Creates `HttpHost` instance with the default scheme and port and the given hostname.
public	HttpHost(final InetAddress the inet address. address, final int the port number. `-1` indicates the scheme default port. port, final String the name of the scheme. `null` indicates the `default scheme` scheme) Creates `HttpHost` instance with the given scheme, inet address and port.
public	HttpHost(final InetAddress the inet address. address, final String the hostname (IP or DNS name) hostname, final int the port number. `-1` indicates the scheme default port. port, final String the name of the scheme. `null` indicates the `default scheme` scheme) Creates a new `HttpHost`, specifying all values.
public	HttpHost(final InetAddress the inet address. address, final int the port number. `-1` indicates the scheme default port. port) Creates `HttpHost` instance with the default scheme and the given inet address and port.
public	HttpHost(final InetAddress the inet address. address) Creates `HttpHost` instance with the default scheme and port and the given inet address.
public	HttpHost(final HttpHost the HTTP host to copy details from httphost) Copy constructor for `HttpHost`.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public static HttpHost	create(final String s) Creates `HttpHost` instance from string.
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public InetAddress	Returns: the inet address getAddress() Returns the inet address if explicitly set by a constructor, `null` otherwise.
public String	Returns: the host name (IP or DNS name) getHostName() Returns the host name.
public int	Returns: the host port, or `-1` if not set getPort() Returns the port.
public String	Returns: the scheme name getSchemeName() Returns the scheme name.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public String	Returns: the host string, for example `localhost:8080` toHostString() Obtains the host string, without scheme prefix.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	Returns: the host URI toURI() Return the host URI, as a string.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

Field Detail

address	back to summary
protected final InetAddress address

DEFAULT_SCHEME_NAME	back to summary
public static final String DEFAULT_SCHEME_NAME The default scheme is "http".

hostname	back to summary
protected final String hostname The host to use.

lcHostname	back to summary
protected final String lcHostname The lowercase host, for `equals` and `hashCode`.

port	back to summary
protected final int port The port to use, defaults to -1 if not set.

schemeName	back to summary
protected final String schemeName The scheme (lowercased)

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final String hostname, final int port, final String scheme) Creates `HttpHost` instance with the given scheme, hostname and port. Parameters hostname:String the hostname (IP or DNS name) port:int the port number. `-1` indicates the scheme default port. scheme:String the name of the scheme. `null` indicates the `default scheme`

public HttpHost(final String hostname, final int port, final String scheme)

Creates HttpHost instance with the given scheme, hostname and port.

Parameters

hostname:String: the hostname (IP or DNS name)
port:int: the port number. -1 indicates the scheme default port.
scheme:String: the name of the scheme. null indicates the default scheme

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final String hostname, final int port) Creates `HttpHost` instance with the default scheme and the given hostname and port. Parameters hostname:String the hostname (IP or DNS name) port:int the port number. `-1` indicates the scheme default port.

public HttpHost(final String hostname, final int port)

Creates HttpHost instance with the default scheme and the given hostname and port.

Parameters

hostname:String: the hostname (IP or DNS name)
port:int: the port number. -1 indicates the scheme default port.

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final String hostname) Creates `HttpHost` instance with the default scheme and port and the given hostname. Parameters hostname:String the hostname (IP or DNS name)

public HttpHost(final String hostname)

Creates HttpHost instance with the default scheme and port and the given hostname.

Parameters

hostname:String: the hostname (IP or DNS name)

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final InetAddress address, final int port, final String scheme) Creates `HttpHost` instance with the given scheme, inet address and port. Parameters address:InetAddress the inet address. port:int the port number. `-1` indicates the scheme default port. scheme:String the name of the scheme. `null` indicates the `default scheme` Since 4.3

public HttpHost(final InetAddress address, final int port, final String scheme)

Creates HttpHost instance with the given scheme, inet address and port.

Parameters

address:InetAddress: the inet address.
port:int: the port number. -1 indicates the scheme default port.
scheme:String: the name of the scheme. null indicates the default scheme

Since

4.3

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final InetAddress address, final String hostname, final int port, final String scheme) Creates a new `HttpHost`, specifying all values. Constructor for HttpHost. Parameters address:InetAddress the inet address. hostname:String the hostname (IP or DNS name) port:int the port number. `-1` indicates the scheme default port. scheme:String the name of the scheme. `null` indicates the `default scheme` Since 4.4

public HttpHost(final InetAddress address, final String hostname, final int port, final String scheme)

Creates a new HttpHost, specifying all values. Constructor for HttpHost.

Parameters

address:InetAddress: the inet address.
hostname:String: the hostname (IP or DNS name)
port:int: the port number. -1 indicates the scheme default port.
scheme:String: the name of the scheme. null indicates the default scheme

Since

4.4

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final InetAddress address, final int port) Creates `HttpHost` instance with the default scheme and the given inet address and port. Parameters address:InetAddress the inet address. port:int the port number. `-1` indicates the scheme default port. Since 4.3

public HttpHost(final InetAddress address, final int port)

Creates HttpHost instance with the default scheme and the given inet address and port.

Parameters

address:InetAddress: the inet address.
port:int: the port number. -1 indicates the scheme default port.

Since

4.3

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final InetAddress address) Creates `HttpHost` instance with the default scheme and port and the given inet address. Parameters address:InetAddress the inet address. Since 4.3

public HttpHost(final InetAddress address)

Creates HttpHost instance with the default scheme and port and the given inet address.

Parameters

address:InetAddress: the inet address.

Since

4.3

HttpHost back to summary

HttpHost	back to summary
public HttpHost(final HttpHost httphost) Copy constructor for `HttpHost`. Parameters httphost:HttpHost the HTTP host to copy details from

public HttpHost(final HttpHost httphost)

Copy constructor for HttpHost.

Parameters

httphost:HttpHost: the HTTP host to copy details from

Method Detail

clone back to summary

clone	back to summary
public Object clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

create back to summary

create	back to summary
public static HttpHost create(final String s) Creates `HttpHost` instance from string. Text may not contain any blanks. Since 4.4

public static HttpHost create(final String s)

Creates HttpHost instance from string. Text may not contain any blanks.

Since: 4.4

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAddress back to summary

getAddress	back to summary
public InetAddress getAddress() Returns the inet address if explicitly set by a constructor, `null` otherwise. Returns:InetAddress the inet address Since 4.3

public InetAddress getAddress()

Returns the inet address if explicitly set by a constructor, null otherwise.

Returns:InetAddress: the inet address
Since: 4.3

getHostName	back to summary
public String getHostName() Returns the host name. Returns:String the host name (IP or DNS name)

getHostName

back to summary

public String getHostName()

Returns the host name.

Returns:String: the host name (IP or DNS name)

getPort back to summary

getPort	back to summary
public int getPort() Returns the port. Returns:int the host port, or `-1` if not set

public int getPort()

Returns the port.

Returns:int: the host port, or -1 if not set

getSchemeName	back to summary
public String getSchemeName() Returns the scheme name. Returns:String the scheme name

getSchemeName

back to summary

public String getSchemeName()

Returns the scheme name.

Returns:String: the scheme name

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override See Also `java.lang.Object#hashCode()`

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

See Also

java.lang.Object#hashCode()

toHostString back to summary

toHostString	back to summary
public String toHostString() Obtains the host string, without scheme prefix. Returns:String the host string, for example `localhost:8080`

public String toHostString()

Obtains the host string, without scheme prefix.

Returns:String: the host string, for example localhost:8080

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations