Class HostAndPort
-
- com.google.common.net.HostAndPort
-
- All Implemented Interfaces:
@Beta @GwtCompatible public final class HostAndPort extends implements
An immutable representation of a host and port.Example usage:
HostAndPort hp = HostAndPort.fromString("[2001:db8::1]") .withDefaultPort(80) .requireBracketsForIPv6(); hp.getHost(); // returns "2001:db8::1" hp.getPort(); // returns 80 hp.toString(); // returns "[2001:db8::1]:80"
Here are some examples of recognized formats:
- example.com
- example.com:80
- 192.0.2.1
- 192.0.2.1:80
- [2001:db8::1] -
getHost()
omits brackets - [2001:db8::1]:80 -
getHost()
omits brackets - 2001:db8::1 - Use
requireBracketsForIPv6()
to prohibit this
Note that this is not an exhaustive list, because these methods are only concerned with brackets, colons, and port numbers. Full validation of the host field (if desired) is the caller's responsibility.
- Since:
- 10.0
- Author:
- Paul Marks
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
other)
Indicates whether some other object is "equal to" this one.static HostAndPort
host)
Build a HostAndPort instance from a host only.static HostAndPort
host, int port)
Build a HostAndPort instance from separate host and port values.static HostAndPort
hostPortString)
Split a freeform string into a host and port, without strict validation.getHost()
Returns the portion of thisHostAndPort
instance that should represent the hostname or IPv4/IPv6 literal.int
getPort()
Get the current port number, failing if no port is defined.int
getPortOrDefault(int defaultPort)
Returns the current port number, with a default if no port is defined.int
hashCode()
Returns a hash code value for the object.boolean
hasPort()
Return true if this instance has a defined port.HostAndPort
requireBracketsForIPv6()
Generate an error if the host might be a non-bracketed IPv6 literal.toString()
Rebuild the host:port string, including brackets if necessary.HostAndPort
withDefaultPort(int defaultPort)
Provide a default port if the parsed string contained only a host.
-
-
-
Method Detail
-
getHost
public getHost()
Returns the portion of thisHostAndPort
instance that should represent the hostname or IPv4/IPv6 literal.A successful parse does not imply any degree of sanity in this field. For additional validation, see the
HostSpecifier
class.- Since:
- 20.0 (since 10.0 as
getHostText
)
-
hasPort
public boolean hasPort()
Return true if this instance has a defined port.
-
getPort
public int getPort()
Get the current port number, failing if no port is defined.- Returns:
- a validated port number, in the range [0..65535]
- Throws:
- if no port is defined. You can use
withDefaultPort(int)
to prevent this from occurring.
-
getPortOrDefault
public int getPortOrDefault(int defaultPort)
Returns the current port number, with a default if no port is defined.
-
fromParts
public static host, int port)
Build a HostAndPort instance from separate host and port values.Note: Non-bracketed IPv6 literals are allowed. Use
requireBracketsForIPv6()
to prohibit these.- Parameters:
host
- the host string to parse. Must not contain a port number.port
- a port number from [0..65535]- Returns:
- if parsing was successful, a populated HostAndPort object.
- Throws:
- if
host
contains a port number, orport
is out of range.
-
fromHost
public static host)
Build a HostAndPort instance from a host only.Note: Non-bracketed IPv6 literals are allowed. Use
requireBracketsForIPv6()
to prohibit these.- Parameters:
host
- the host-only string to parse. Must not contain a port number.- Returns:
- if parsing was successful, a populated HostAndPort object.
- Throws:
- if
host
contains a port number.- Since:
- 17.0
-
fromString
public static hostPortString)
Split a freeform string into a host and port, without strict validation.Note that the host-only formats will leave the port field undefined. You can use
withDefaultPort(int)
to patch in a default value.- Parameters:
hostPortString
- the input string to parse.- Returns:
- if parsing was successful, a populated HostAndPort object.
- Throws:
- if nothing meaningful could be parsed.
-
withDefaultPort
public HostAndPort withDefaultPort(int defaultPort)
Provide a default port if the parsed string contained only a host.You can chain this after
fromString(String)
to include a port in case the port was omitted from the input string. If a port was already provided, then this method is a no-op.- Parameters:
defaultPort
- a port number, from [0..65535]- Returns:
- a HostAndPort instance, guaranteed to have a defined port.
-
requireBracketsForIPv6
public HostAndPort requireBracketsForIPv6()
Generate an error if the host might be a non-bracketed IPv6 literal.URI formatting requires that IPv6 literals be surrounded by brackets, like "[2001:db8::1]". Chain this call after
fromString(String)
to increase the strictness of the parser, and disallow IPv6 literals that don't contain these brackets.Note that this parser identifies IPv6 literals solely based on the presence of a colon. To perform actual validation of IP addresses, see the
InetAddresses.forString(String)
method.- Returns:
this
, to enable chaining of calls.- Throws:
- if bracketless IPv6 is detected.
-
equals
public boolean other)
Description copied from class: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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.- Overrides:
in class
- Parameters:
other
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
- ,
- It is reflexive: for any non-null reference value
-
hashCode
public int hashCode()
Description copied from class:Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by .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 inequals
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(Object)
method, then calling thehashCode
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
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.
As much as is reasonably practical, the hashCode method defined by class
Object
does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)- Overrides:
in class
- Returns:
- a hash code value for this object.
- See Also:
- ,
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
toString
public toString()
Rebuild the host:port string, including brackets if necessary.- Overrides:
in class
- Returns:
- a string representation of the object.
-
-