Top Description Fields Constructors Methods
com.google.common.net

public final Class HostSpecifier

extends Object
Class Inheritance
Annotations
@J2ktIncompatible
@GwtIncompatible
@ElementTypesAreNonnullByDefault
Imports
com.google.common.annotations.GwtIncompatible, .J2ktIncompatible, com.google.common.base.Preconditions, com.google.errorprone.annotations.CanIgnoreReturnValue, java.net.InetAddress, java.text.ParseException, javax.annotation.CheckForNull

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 a java.net.InetAddress instance from it rather than using this class. Similarly, if you know that a given string represents a domain name, use InternetDomainName rather than this class.

Author
Craig Berry
Since
5.0

Field Summary

Modifier and TypeField and Description
private final String

Constructor Summary

AccessConstructor and Description
private
HostSpecifier(String canonicalForm)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public static HostSpecifier
from(String specifier)

Attempts to return a HostSpecifier for the given string, throwing an exception if parsing fails.

public static HostSpecifier
fromValid(String specifier)

Returns a HostSpecifier built from the provided specifier, which is already known to be valid.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public static boolean
isValid(String specifier)

Determines whether specifier represents a valid HostSpecifier as described in the documentation for fromValid(String).

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the host specifier suitable for inclusion in a URI.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

canonicalFormback to summary
private final String canonicalForm

Constructor Detail

HostSpecifierback to summary
private HostSpecifier(String canonicalForm)

Method Detail

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values 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.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
fromback to summary
public static HostSpecifier from(String specifier) throws ParseException

Attempts to return a HostSpecifier for the given string, throwing an exception if parsing fails. Always use this method in preference to fromValid(String) for a specifier that is not already known to be valid.

Annotations
@CanIgnoreReturnValue
Exceptions
ParseException:
if the specifier is not valid.
fromValidback to summary
public static HostSpecifier fromValid(String specifier)

Returns a HostSpecifier built from the provided specifier, which is already known to be valid. If the specifier might be invalid, use from(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] or 2001:db8::1
Exceptions
IllegalArgumentException:
if the specifier is not valid.
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

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 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.
  • If two objects are equal according to the equals method, then calling the hashCode 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 equals 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.
Returns:int

a hash code value for this object.

Annotations
@Override
isValidback to summary
public static boolean isValid(String specifier)

Determines whether specifier represents a valid HostSpecifier as described in the documentation for fromValid(String).

toStringback to summary
public String toString()

Overrides java.lang.Object.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.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override