@Beta @Immutable @GwtCompatible public final class HostAndPort extends Object implements Serializable
HostAndPort hp = HostAndPort.fromString("[2001:db8::1]") .withDefaultPort(80) .requireBracketsForIPv6(); hp.getHostText(); // returns "2001:db8::1" hp.getPort(); // returns 80 hp.toString(); // returns "[2001:db8::1]:80"
Here are some examples of recognized formats:
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|
Indicates whether some other object is "equal to" this one.
Build a HostAndPort instance from separate host and port values.
Split a freeform string into a host and port, without strict validation.
Returns the portion of this
Get the current port number, failing if no port is defined.
Returns the current port number, with a default if no port is defined.
Returns a hash code value for the object.
Return true if this instance has a defined port.
Generate an error if the host might be a non-bracketed IPv6 literal.
Rebuild the host:port string, including brackets if necessary.
Provide a default port if the parsed string contained only a host.
public String getHostText()
HostAndPortinstance 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
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.
requireBracketsForIPv6() to prohibit these.
host- the host string to parse. Must not contain a port number.
port- a port number from [0..65535]
hostcontains a port number, or
portis out of range.
public static HostAndPort fromString(String hostPortString)
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)
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
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
this, to enable chaining of calls.
IllegalArgumentException- if bracketless IPv6 is detected.
public boolean equals(@Nullable Object other)
equals method implements an equivalence relation
on non-null object references:
trueif and only if
y, multiple invocations of
trueor consistently return
false, provided no information used in
equalscomparisons on the objects is modified.
equals method for class
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values
y, this method returns
true if and only
y refer to the same object
x == y has the value
Note that it is generally necessary to override the
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.
other- the reference object with which to compare.
trueif this object is the same as the obj argument;
public int hashCode()
The general contract of
hashCodemethod must consistently return the same integer, provided no information used in
equalscomparisons 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
hashCodemethod on each of the two objects must produce the same integer result.
Object.equals(java.lang.Object)method, then calling the
hashCodemethod 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
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
JavaTM programming language.)
Copyright © 2010-2013. All Rights Reserved.