@Beta @Immutable @GwtCompatible public final class HostAndPort extends Object implements Serializable
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:
getHost()
omits brackets
getHost()
omits brackets
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.
Modifier and Type | Method and Description |
---|---|
boolean |
equals(@Nullable Object other)
Indicates whether some other object is "equal to" this one.
|
static HostAndPort |
fromHost(String host)
Build a HostAndPort instance from a host only.
|
static HostAndPort |
fromParts(String host,
int port)
Build a HostAndPort instance from separate host and port values.
|
static HostAndPort |
fromString(String hostPortString)
Split a freeform string into a host and port, without strict validation.
|
String |
getHost()
Returns the portion of this
HostAndPort 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.
|
String |
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.
|
public String getHost()
HostAndPort
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.
getHostText
)public boolean hasPort()
public int getPort()
IllegalStateException
- if no port is defined. You can use withDefaultPort(int)
to prevent this from occurring.public int getPortOrDefault(int defaultPort)
public static HostAndPort fromParts(String host, int port)
Note: Non-bracketed IPv6 literals are allowed. Use requireBracketsForIPv6()
to
prohibit these.
host
- the host string to parse. Must not contain a port number.port
- a port number from [0..65535]IllegalArgumentException
- if host
contains a port number, or port
is out
of range.public static HostAndPort fromHost(String host)
Note: Non-bracketed IPv6 literals are allowed. Use requireBracketsForIPv6()
to
prohibit these.
host
- the host-only string to parse. Must not contain a port number.IllegalArgumentException
- if host
contains a port number.public static HostAndPort fromString(String hostPortString)
Note that the host-only formats will leave the port field undefined. You can use withDefaultPort(int)
to patch in a default value.
hostPortString
- the input string to parse.IllegalArgumentException
- if nothing meaningful could be parsed.public HostAndPort withDefaultPort(int defaultPort)
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.
defaultPort
- a port number, from [0..65535]public HostAndPort requireBracketsForIPv6()
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.
this
, to enable chaining of calls.IllegalArgumentException
- if bracketless IPv6 is detected.public boolean equals(@Nullable Object other)
java.lang.Object
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
equals
in class Object
other
- the reference object with which to compare.true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap
public int hashCode()
java.lang.Object
HashMap
.
The general contract of hashCode
is:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
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. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
Copyright © 2010–2019. All rights reserved.