Package org.apache.http
Class HttpHost
java.lang.Object
org.apache.http.HttpHost
- All Implemented Interfaces:
Cloneable
public final class HttpHost extends Object implements Cloneable
Holds all of the variables needed to describe an HTTP connection to a host.
This includes remote host name, port and scheme.
- Since:
- 4.0
- Author:
- Michael Becke, Mike Bowler, Oleg Kalnichevski, Laura Werner
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_SCHEME_NAMEThe default scheme is "http".protected StringhostnameThe host to use.protected StringlcHostnameThe lowercase host, forequals(java.lang.Object)andhashCode().protected intportThe port to use.protected StringschemeNameThe scheme -
Constructor Summary
Constructors Constructor Description HttpHost(String hostname)Creates a newHttpHost, with default scheme and port.HttpHost(String hostname, int port)Creates a newHttpHost, with default scheme.HttpHost(String hostname, int port, String scheme)Creates a newHttpHost, specifying all values.HttpHost(HttpHost httphost)Copy constructor forHttpHost. -
Method Summary
Modifier and Type Method Description Objectclone()Creates and returns a copy of thisObject.booleanequals(Object obj)Compares this instance with the specified object and indicates if they are equal.StringgetHostName()Returns the host name.intgetPort()Returns the port.StringgetSchemeName()Returns the scheme name.inthashCode()Returns an integer hash code for this object.StringtoHostString()Obtains the host string, without scheme prefix.StringtoString()Returns a string containing a concise, human-readable description of this object.StringtoURI()Return the host URI, as a string.
-
Field Details
-
DEFAULT_SCHEME_NAME
The default scheme is "http".- See Also:
- Constant Field Values
-
hostname
The host to use. -
lcHostname
The lowercase host, forequals(java.lang.Object)andhashCode(). -
port
protected final int portThe port to use. -
schemeName
The scheme
-
-
Constructor Details
-
HttpHost
Creates a newHttpHost, specifying all values. Constructor for HttpHost.- Parameters:
hostname- the hostname (IP or DNS name)port- the port number.-1indicates the scheme default port.scheme- the name of the scheme.nullindicates thedefault scheme
-
HttpHost
Creates a newHttpHost, with default scheme.- Parameters:
hostname- the hostname (IP or DNS name)port- the port number.-1indicates the scheme default port.
-
HttpHost
Creates a newHttpHost, with default scheme and port.- Parameters:
hostname- the hostname (IP or DNS name)
-
HttpHost
Copy constructor forHttpHost.- Parameters:
httphost- the HTTP host to copy details from
-
-
Method Details
-
getHostName
Returns the host name.- Returns:
- the host name (IP or DNS name)
-
getPort
public int getPort()Returns the port.- Returns:
- the host port, or
-1if not set
-
getSchemeName
Returns the scheme name.- Returns:
- the scheme name
-
toURI
Return the host URI, as a string.- Returns:
- the host URI
-
toHostString
Obtains the host string, without scheme prefix.- Returns:
- the host string, for example
localhost:8080
-
toString
Description copied from class:ObjectReturns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:getClass().getName() + '@' + Integer.toHexString(hashCode())
See Writing a useful
toStringmethod if you intend implementing your owntoStringmethod. -
equals
Description copied from class:ObjectCompares this instance with the specified object and indicates if they are equal. In order to be equal,omust represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.The default implementation returns
trueonly ifthis == o. See Writing a correctequalsmethod if you intend implementing your ownequalsmethod.The general contract for the
equalsandObject.hashCode()methods is that ifequalsreturnstruefor any two objects, thenhashCode()must return the same value for these objects. This means that subclasses ofObjectusually override either both methods or neither of them.- Overrides:
equalsin classObject- Parameters:
obj- the object to compare this instance with.- Returns:
trueif the specified object is equal to thisObject;falseotherwise.- See Also:
Object.hashCode()
-
hashCode
public int hashCode()Description copied from class:ObjectReturns an integer hash code for this object. By contract, any two objects for whichObject.equals(java.lang.Object)returnstruemust return the same hash code value. This means that subclasses ofObjectusually override both methods or neither method.Note that hash values must not change over time unless information used in equals comparisons also changes.
See Writing a correct
hashCodemethod if you intend implementing your ownhashCodemethod.- Overrides:
hashCodein classObject- Returns:
- this object's hash code.
- See Also:
Object.hashCode()
-
clone
Description copied from class:ObjectCreates and returns a copy of thisObject. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should callsuper.clone()to create the new instance and then create deep copies of the nested, mutable objects.- Overrides:
clonein classObject- Returns:
- a copy of this object.
- Throws:
CloneNotSupportedException- if this object's class does not implement theCloneableinterface.
-