@Beta @GwtCompatible public final class HostAndPort extends java.lang.Object implements java.io.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 | Field and Description |
---|---|
private boolean |
hasBracketlessColons
True if the parsed host has colons, but no surrounding brackets.
|
private java.lang.String |
host
Hostname, IPv4/IPv6 literal, or unvalidated nonsense.
|
private static int |
NO_PORT
Magic value indicating the absence of a port number.
|
private int |
port
Validated port number in the range [0..65535], or NO_PORT
|
private static long |
serialVersionUID |
Modifier | Constructor and Description |
---|---|
private |
HostAndPort(java.lang.String host,
int port,
boolean hasBracketlessColons) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object other) |
static HostAndPort |
fromHost(java.lang.String host)
Build a HostAndPort instance from a host only.
|
static HostAndPort |
fromParts(java.lang.String host,
int port)
Build a HostAndPort instance from separate host and port values.
|
static HostAndPort |
fromString(java.lang.String hostPortString)
Split a freeform string into a host and port, without strict validation.
|
java.lang.String |
getHost()
Returns the portion of this
HostAndPort instance that should represent the hostname or
IPv4/IPv6 literal. |
private static java.lang.String[] |
getHostAndPortFromBracketedHost(java.lang.String hostPortString)
Parses a bracketed host-port string, throwing IllegalArgumentException if parsing fails.
|
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() |
boolean |
hasPort()
Return true if this instance has a defined port.
|
private static boolean |
isValidPort(int port)
Return true for valid port numbers.
|
HostAndPort |
requireBracketsForIPv6()
Generate an error if the host might be a non-bracketed IPv6 literal.
|
java.lang.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.
|
private static final int NO_PORT
private final java.lang.String host
private final int port
private final boolean hasBracketlessColons
private static final long serialVersionUID
private HostAndPort(java.lang.String host, int port, boolean hasBracketlessColons)
public java.lang.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()
java.lang.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(java.lang.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]java.lang.IllegalArgumentException
- if host
contains a port number, or port
is out
of range.public static HostAndPort fromHost(java.lang.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.java.lang.IllegalArgumentException
- if host
contains a port number.public static HostAndPort fromString(java.lang.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.java.lang.IllegalArgumentException
- if nothing meaningful could be parsed.private static java.lang.String[] getHostAndPortFromBracketedHost(java.lang.String hostPortString)
hostPortString
- the full bracketed host-port specification. Post might not be specified.java.lang.IllegalArgumentException
- if parsing the bracketed host-port string fails.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.java.lang.IllegalArgumentException
- if bracketless IPv6 is detected.public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
private static boolean isValidPort(int port)