Class HostSpecifier
- java.lang.Object
-
- com.google.common.net.HostSpecifier
-
@GwtIncompatible public final class HostSpecifier extends java.lang.Object
A syntactically valid host specifier, suitable for use in a URI. This may be either a numeric IP address in IPv4 or IPv6 notation, or a domain name.Because this class is intended to represent host specifiers which can reasonably be used in a URI, the domain name case is further restricted to include only those domain names which end in a recognized public suffix; see
InternetDomainName.isPublicSuffix()
for details.Note that no network lookups are performed by any
HostSpecifier
methods. No attempt is made to verify that a provided specifier corresponds to a real or accessible host. Only syntactic and pattern-based checks are performed.If you know that a given string represents a numeric IP address, use
InetAddresses
to obtain and manipulate aInetAddress
instance from it rather than using this class. Similarly, if you know that a given string represents a domain name, useInternetDomainName
rather than this class.- Since:
- 5.0
- Author:
- Craig Berry
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object other)
static HostSpecifier
from(java.lang.String specifier)
Attempts to return aHostSpecifier
for the given string, throwing an exception if parsing fails.static HostSpecifier
fromValid(java.lang.String specifier)
Returns aHostSpecifier
built from the providedspecifier
, which is already known to be valid.int
hashCode()
static boolean
isValid(java.lang.String specifier)
Determines whetherspecifier
represents a validHostSpecifier
as described in the documentation forfromValid(String)
.java.lang.String
toString()
Returns a string representation of the host specifier suitable for inclusion in a URI.
-
-
-
Method Detail
-
fromValid
public static HostSpecifier fromValid(java.lang.String specifier)
Returns aHostSpecifier
built from the providedspecifier
, which is already known to be valid. If thespecifier
might be invalid, usefrom(String)
instead.The specifier must be in one of these formats:
- A domain name, like
google.com
- A IPv4 address string, like
127.0.0.1
- An IPv6 address string with or without brackets, like
[2001:db8::1]
or2001:db8::1
- Throws:
java.lang.IllegalArgumentException
- if the specifier is not valid.
- A domain name, like
-
from
@CanIgnoreReturnValue public static HostSpecifier from(java.lang.String specifier) throws java.text.ParseException
Attempts to return aHostSpecifier
for the given string, throwing an exception if parsing fails. Always use this method in preference tofromValid(String)
for a specifier that is not already known to be valid.- Throws:
java.text.ParseException
- if the specifier is not valid.
-
isValid
public static boolean isValid(java.lang.String specifier)
Determines whetherspecifier
represents a validHostSpecifier
as described in the documentation forfromValid(String)
.
-
equals
public boolean equals(@CheckForNull java.lang.Object other)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
Returns a string representation of the host specifier suitable for inclusion in a URI. If the host specifier is a domain name, the string will be normalized to all lower case. If the specifier was an IPv6 address without brackets, brackets are added so that the result will be usable in the host part of a URI.- Overrides:
toString
in classjava.lang.Object
-
-