Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.net.InternetDomainName

Modifier and Type	Field and Description
private static final CharMatcher	DASH_MATCHER
private static final CharMatcher	DIGIT_MATCHER
private static final Joiner	DOT_JOINER
private static final Splitter	DOT_SPLITTER
private static final CharMatcher	DOTS_MATCHER
private static final CharMatcher	LETTER_MATCHER
private static final int	MAX_DOMAIN_PART_LENGTH Maximum size of a single part of a domain name.
private static final int	MAX_LENGTH Maximum length of a full domain name, including separators, and leaving room for the root label.
private static final int	MAX_PARTS Maximum parts (labels) in a domain name.
private final String	name The full domain name, converted to lower case.
private static final int	NO_SUFFIX_FOUND Value of `publicSuffixIndex()` or `registrySuffixIndex()` which indicates that no relevant suffix was found.
private static final CharMatcher	PART_CHAR_MATCHER
private final ImmutableList<String>	parts The parts of the domain name, converted to lower case.
private int	publicSuffixIndexCache Cached value of #publicSuffixIndex().
private int	registrySuffixIndexCache Cached value of #registrySuffixIndex().
private static final int	SUFFIX_NOT_INITIALIZED Value of `publicSuffixIndexCache` or `registrySuffixIndexCache` which indicates that they were not initialized yet.

Access	Constructor and Description
pack-priv	InternetDomainName(String name) Constructor used to implement `from(String)`, and from subclasses.
private	InternetDomainName(String name, ImmutableList<String> parts) Internal constructor that skips validations when creating an instance from parts of an already-validated InternetDomainName, as in `ancestor`.

Method Summary

Modifier and Type	Method and Description
private InternetDomainName	ancestor(int levels) Returns the ancestor of the current domain at the given number of levels "higher" (rightward) in the subdomain list.
public InternetDomainName	child(String leftParts) Creates and returns a new `InternetDomainName` by prepending the argument and a dot to the current name.
public boolean	equals(Object the reference object with which to compare. object) Overrides java.lang.Object.equals. Equality testing is based on the text supplied by the caller, after normalization as described in the class documentation.
private int	findSuffixOfType(Optional<PublicSuffixType> desiredType) Returns the index of the leftmost part of the suffix, or -1 if not found.
public static InternetDomainName	from(String A domain name (not IP address) domain) Returns an instance of `InternetDomainName` after lenient validation.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasParent() Indicates whether this domain is composed of two or more parts.
public boolean	hasPublicSuffix() Indicates whether this domain name ends in a public suffix, including if it is a public suffix itself.
public boolean	hasRegistrySuffix() Indicates whether this domain name ends in a registry suffix, including if it is a registry suffix itself.
public boolean	Returns: `true` if this domain name appears exactly on the public suffix list isPublicSuffix() Indicates whether this domain name represents a public suffix, as defined by the Mozilla Foundation's Public Suffix List (PSL).
public boolean	Returns: `true` if this domain name appears exactly on the public suffix list as part of the registry suffix section (labelled "ICANN"). isRegistrySuffix() Indicates whether this domain name represents a registry suffix, as defined by a subset of the Mozilla Foundation's Public Suffix List (PSL).
public boolean	isTopDomainUnderRegistrySuffix() Indicates whether this domain name is composed of exactly one subdomain component followed by a registry suffix.
public boolean	isTopPrivateDomain() Indicates whether this domain name is composed of exactly one subdomain component followed by a public suffix.
public boolean	isUnderPublicSuffix() Indicates whether this domain name ends in a public suffix, while not being a public suffix itself.
public boolean	isUnderRegistrySuffix() Indicates whether this domain name ends in a registry suffix, while not being a registry suffix itself.
public static boolean	isValid(String name) Indicates whether the argument is a syntactically valid domain name using lenient validation.
private static boolean	matchesType(Optional<PublicSuffixType> desiredType, Optional<PublicSuffixType> actualType) If a `desiredType` is specified, returns true only if the `actualType` is identical.
public InternetDomainName	parent() Returns an `InternetDomainName` that is the immediate ancestor of this one; that is, the current domain with the leftmost part removed.
public ImmutableList<String>	parts() Returns the individual components of this domain name, normalized to all lower case.
public InternetDomainName	publicSuffix() Returns the public suffix portion of the domain name, or `null` if no public suffix is present.
private int	publicSuffixIndex() The index in the `parts()` list at which the public suffix begins.
public InternetDomainName	registrySuffix() Returns the registry suffix portion of the domain name, or `null` if no registry suffix is present.
private int	registrySuffixIndex() The index in the `parts()` list at which the registry suffix begins.
public InternetDomainName	topDomainUnderRegistrySuffix() Returns the portion of this domain name that is one level beneath the registry suffix.
public InternetDomainName	topPrivateDomain() Returns the portion of this domain name that is one level beneath the public suffix.
public String	toString() Overrides java.lang.Object.toString. Returns the domain name, normalized to all lower case.
private static boolean	Returns: Whether the part is valid validatePart(String The domain name part to be validated part, boolean Is this the final (rightmost) domain part? isFinalPart) Helper method for `validateSyntax(List)`.
private static boolean	Returns: Is the domain name syntactically valid? validateSyntax(List<String> parts) Validation method used by `from` to ensure that the domain name is syntactically valid according to RFC 1035.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

DASH_MATCHER	back to summary
private static final CharMatcher DASH_MATCHER

DIGIT_MATCHER	back to summary
private static final CharMatcher DIGIT_MATCHER

DOT_JOINER	back to summary
private static final Joiner DOT_JOINER

DOT_SPLITTER	back to summary
private static final Splitter DOT_SPLITTER

DOTS_MATCHER	back to summary
private static final CharMatcher DOTS_MATCHER

LETTER_MATCHER	back to summary
private static final CharMatcher LETTER_MATCHER

MAX_DOMAIN_PART_LENGTH	back to summary
private static final int MAX_DOMAIN_PART_LENGTH Maximum size of a single part of a domain name. See RFC 2181 part 11.

MAX_LENGTH	back to summary
private static final int MAX_LENGTH Maximum length of a full domain name, including separators, and leaving room for the root label. See RFC 2181 part 11.

MAX_PARTS	back to summary
private static final int MAX_PARTS Maximum parts (labels) in a domain name. This value arises from the 255-octet limit described in RFC 2181 part 11 with the fact that the encoding of each part occupies at least two bytes (dot plus label externally, length byte plus label internally). Thus, if all labels have the minimum size of one byte, 127 of them will fit.

name	back to summary
private final String name The full domain name, converted to lower case.

NO_SUFFIX_FOUND	back to summary
private static final int NO_SUFFIX_FOUND Value of `publicSuffixIndex()` or `registrySuffixIndex()` which indicates that no relevant suffix was found.

PART_CHAR_MATCHER	back to summary
private static final CharMatcher PART_CHAR_MATCHER

parts	back to summary
private final ImmutableList<String> parts The parts of the domain name, converted to lower case.

publicSuffixIndexCache	back to summary
private int publicSuffixIndexCache Cached value of #publicSuffixIndex(). Do not use directly. Since this field isn't `volatile`, if an instance of this class is shared across threads before it is initialized, then each thread is likely to compute their own copy of the value. Annotations @SuppressWarnings:Immutable @LazyInit

registrySuffixIndexCache	back to summary
private int registrySuffixIndexCache Cached value of #registrySuffixIndex(). Do not use directly. Since this field isn't `volatile`, if an instance of this class is shared across threads before it is initialized, then each thread is likely to compute their own copy of the value. Annotations @SuppressWarnings:Immutable @LazyInit

SUFFIX_NOT_INITIALIZED	back to summary
private static final int SUFFIX_NOT_INITIALIZED Value of `publicSuffixIndexCache` or `registrySuffixIndexCache` which indicates that they were not initialized yet.

InternetDomainName	back to summary
pack-priv InternetDomainName(String name) Constructor used to implement `from(String)`, and from subclasses.

InternetDomainName	back to summary
private InternetDomainName(String name, ImmutableList<String> parts) Internal constructor that skips validations when creating an instance from parts of an already-validated InternetDomainName, as in `ancestor`.

Method Detail

ancestor	back to summary
private InternetDomainName ancestor(int levels) Returns the ancestor of the current domain at the given number of levels "higher" (rightward) in the subdomain list. The number of levels must be non-negative, and less than `N-1`, where `N` is the number of parts in the domain. Todo Reasonable candidate for addition to public API.

child back to summary

child	back to summary
public InternetDomainName child(String leftParts) Creates and returns a new `InternetDomainName` by prepending the argument and a dot to the current name. For example, `InternetDomainName.from("foo.com").child("www.bar")` returns a new `InternetDomainName` with the value `www.bar.foo.com`. Only lenient validation is performed, as described `here`. Exceptions NullPointerException: if leftParts is null IllegalArgumentException: if the resulting name is not valid

public InternetDomainName child(String leftParts)

Creates and returns a new InternetDomainName by prepending the argument and a dot to the current name. For example, InternetDomainName.from("foo.com").child("www.bar") returns a new InternetDomainName with the value www.bar.foo.com. Only lenient validation is performed, as described here.

Exceptions

NullPointerException:: if leftParts is null
IllegalArgumentException:: if the resulting name is not valid

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Equality testing is based on the text supplied by the caller, after normalization as described in the class documentation. For example, a non-ASCII Unicode domain name and the Punycode version of the same domain name would not be considered equal. Parameters object:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Equality testing is based on the text supplied by the caller, after normalization as described in the class documentation. For example, a non-ASCII Unicode domain name and the Punycode version of the same domain name would not be considered equal.

Parameters

object:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

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

Annotations

@Override

findSuffixOfType back to summary

findSuffixOfType	back to summary
private int findSuffixOfType(Optional<PublicSuffixType> desiredType) Returns the index of the leftmost part of the suffix, or -1 if not found. Note that the value defined as a suffix may not produce `true` results from `isPublicSuffix()` or `isRegistrySuffix()` if the domain ends with an excluded domain pattern such as `"nhs.uk"`. If a `desiredType` is specified, this method only finds suffixes of the given type. Otherwise, it finds the first suffix of any type.

private int findSuffixOfType(Optional<PublicSuffixType> desiredType)

Returns the index of the leftmost part of the suffix, or -1 if not found. Note that the value defined as a suffix may not produce true results from isPublicSuffix() or isRegistrySuffix() if the domain ends with an excluded domain pattern such as "nhs.uk".

If a desiredType is specified, this method only finds suffixes of the given type. Otherwise, it finds the first suffix of any type.

from back to summary

from	back to summary
public static InternetDomainName from(String domain) Returns an instance of `InternetDomainName` after lenient validation. Specifically, validation against RFC 3490 ("Internationalizing Domain Names in Applications") is skipped, while validation against RFC 1035 is relaxed in the following ways: Any part containing non-ASCII characters is considered valid. Underscores ('_') are permitted wherever dashes ('-') are permitted. Parts other than the final part may start with a digit, as mandated by RFC 1123. Parameters domain:String A domain name (not IP address) Annotations @CanIgnoreReturnValue Exceptions IllegalArgumentException: if `domain` is not syntactically valid according to `isValid` Since 10.0 (previously named `fromLenient`)

public static InternetDomainName from(String domain)

Returns an instance of InternetDomainName after lenient validation. Specifically, validation against RFC 3490 ("Internationalizing Domain Names in Applications") is skipped, while validation against RFC 1035 is relaxed in the following ways:

Any part containing non-ASCII characters is considered valid.
Underscores ('_') are permitted wherever dashes ('-') are permitted.
Parts other than the final part may start with a digit, as mandated by RFC 1123.

Parameters

domain:String: A domain name (not IP address)

Annotations

@CanIgnoreReturnValue

Exceptions

IllegalArgumentException:: if domain is not syntactically valid according to isValid

Since

10.0 (previously named fromLenient)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this 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

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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

hasParent	back to summary
public boolean hasParent() Indicates whether this domain is composed of two or more parts.

hasPublicSuffix back to summary

hasPublicSuffix	back to summary
public boolean hasPublicSuffix() Indicates whether this domain name ends in a public suffix, including if it is a public suffix itself. For example, returns `true` for `www.google.com`, `foo.co.uk` and `com`, but not for `invalid` or `google.invalid`. This is the recommended method for determining whether a domain is potentially an addressable host. Note that this method is equivalent to `hasRegistrySuffix()` because all registry suffixes are public suffixes and all public suffixes have registry suffixes. Since 6.0

public boolean hasPublicSuffix()

Indicates whether this domain name ends in a public suffix, including if it is a public suffix itself. For example, returns true for www.google.com, foo.co.uk and com, but not for invalid or google.invalid. This is the recommended method for determining whether a domain is potentially an addressable host.

Note that this method is equivalent to hasRegistrySuffix() because all registry suffixes are public suffixes and all public suffixes have registry suffixes.

Since: 6.0

hasRegistrySuffix back to summary

hasRegistrySuffix	back to summary
public boolean hasRegistrySuffix() Indicates whether this domain name ends in a registry suffix, including if it is a registry suffix itself. For example, returns `true` for `www.google.com`, `foo.co.uk` and `com`, but not for `invalid` or `google.invalid`. Note that this method is equivalent to `hasPublicSuffix()` because all registry suffixes are public suffixes and all public suffixes have registry suffixes. Since 23.3

public boolean hasRegistrySuffix()

Indicates whether this domain name ends in a registry suffix, including if it is a registry suffix itself. For example, returns true for www.google.com, foo.co.uk and com, but not for invalid or google.invalid.

Note that this method is equivalent to hasPublicSuffix() because all registry suffixes are public suffixes and all public suffixes have registry suffixes.

Since: 23.3

isPublicSuffix back to summary

isPublicSuffix	back to summary
public boolean isPublicSuffix() Indicates whether this domain name represents a public suffix, as defined by the Mozilla Foundation's Public Suffix List (PSL). A public suffix is one under which Internet users can directly register names, such as `com`, `co.uk` or `pvt.k12.wy.us`. Examples of domain names that are not public suffixes include `google.com`, `foo.co.uk`, and `myblog.blogspot.com`. Public suffixes are a proper superset of registry suffixes. The list of public suffixes additionally contains privately owned domain names under which Internet users can register subdomains. An example of a public suffix that is not a registry suffix is `blogspot.com`. Note that it is true that all public suffixes have registry suffixes, since domain name registries collectively control all internet domain names. For considerations on whether the public suffix or registry suffix designation is more suitable for your application, see this article. Returns:boolean `true` if this domain name appears exactly on the public suffix list Since 6.0

public boolean isPublicSuffix()

Indicates whether this domain name represents a public suffix, as defined by the Mozilla Foundation's Public Suffix List (PSL). A public suffix is one under which Internet users can directly register names, such as com, co.uk or pvt.k12.wy.us. Examples of domain names that are not public suffixes include google.com, foo.co.uk, and myblog.blogspot.com.

Public suffixes are a proper superset of registry suffixes. The list of public suffixes additionally contains privately owned domain names under which Internet users can register subdomains. An example of a public suffix that is not a registry suffix is blogspot.com. Note that it is true that all public suffixes have registry suffixes, since domain name registries collectively control all internet domain names.

For considerations on whether the public suffix or registry suffix designation is more suitable for your application, see this article.

Returns:boolean: true if this domain name appears exactly on the public suffix list
Since: 6.0

isRegistrySuffix back to summary

isRegistrySuffix	back to summary
public boolean isRegistrySuffix() Indicates whether this domain name represents a registry suffix, as defined by a subset of the Mozilla Foundation's Public Suffix List (PSL). A registry suffix is one under which Internet users can directly register names via a domain name registrar, and have such registrations lawfully protected by internet-governing bodies such as ICANN. Examples of registry suffixes include `com`, `co.uk`, and `pvt.k12.wy.us`. Examples of domain names that are not registry suffixes include `google.com` and `foo.co.uk`. Registry suffixes are a proper subset of public suffixes. The list of public suffixes additionally contains privately owned domain names under which Internet users can register subdomains. An example of a public suffix that is not a registry suffix is `blogspot.com`. Note that it is true that all public suffixes have registry suffixes, since domain name registries collectively control all internet domain names. For considerations on whether the public suffix or registry suffix designation is more suitable for your application, see this article. Returns:boolean `true` if this domain name appears exactly on the public suffix list as part of the registry suffix section (labelled "ICANN"). Since 23.3

public boolean isRegistrySuffix()

Indicates whether this domain name represents a registry suffix, as defined by a subset of the Mozilla Foundation's Public Suffix List (PSL). A registry suffix is one under which Internet users can directly register names via a domain name registrar, and have such registrations lawfully protected by internet-governing bodies such as ICANN. Examples of registry suffixes include com, co.uk, and pvt.k12.wy.us. Examples of domain names that are not registry suffixes include google.com and foo.co.uk.

Registry suffixes are a proper subset of public suffixes. The list of public suffixes additionally contains privately owned domain names under which Internet users can register subdomains. An example of a public suffix that is not a registry suffix is blogspot.com. Note that it is true that all public suffixes have registry suffixes, since domain name registries collectively control all internet domain names.

For considerations on whether the public suffix or registry suffix designation is more suitable for your application, see this article.

Returns:boolean: true if this domain name appears exactly on the public suffix list as part of the registry suffix section (labelled "ICANN").
Since: 23.3

isTopDomainUnderRegistrySuffix back to summary

isTopDomainUnderRegistrySuffix	back to summary
public boolean isTopDomainUnderRegistrySuffix() Indicates whether this domain name is composed of exactly one subdomain component followed by a registry suffix. For example, returns `true` for `google.com`, `foo.co.uk`, and `blogspot.com`, but not for `www.google.com`, `co.uk`, or `myblog.blogspot.com`. Warning This method should not be used to determine the probable highest level parent domain for which cookies may be set. Use `topPrivateDomain()` for that purpose. Since 23.3

public boolean isTopDomainUnderRegistrySuffix()

Indicates whether this domain name is composed of exactly one subdomain component followed by a registry suffix. For example, returns true for google.com, foo.co.uk, and blogspot.com, but not for www.google.com, co.uk, or myblog.blogspot.com.

Warning

This method should not be used to determine the probable highest level parent domain for which cookies may be set. Use topPrivateDomain() for that purpose.

Since: 23.3

isTopPrivateDomain back to summary

isTopPrivateDomain	back to summary
public boolean isTopPrivateDomain() Indicates whether this domain name is composed of exactly one subdomain component followed by a public suffix. For example, returns `true` for `google.com` `foo.co.uk`, and `myblog.blogspot.com`, but not for `www.google.com`, `co.uk`, or `blogspot.com`. This method can be used to determine whether a domain is probably the highest level for which cookies may be set, though even that depends on individual browsers' implementations of cookie controls. See RFC 2109 for details. Since 6.0

public boolean isTopPrivateDomain()

Indicates whether this domain name is composed of exactly one subdomain component followed by a public suffix. For example, returns true for google.com foo.co.uk, and myblog.blogspot.com, but not for www.google.com, co.uk, or blogspot.com.

This method can be used to determine whether a domain is probably the highest level for which cookies may be set, though even that depends on individual browsers' implementations of cookie controls. See RFC 2109 for details.

Since: 6.0

isUnderPublicSuffix back to summary

isUnderPublicSuffix	back to summary
public boolean isUnderPublicSuffix() Indicates whether this domain name ends in a public suffix, while not being a public suffix itself. For example, returns `true` for `www.google.com`, `foo.co.uk` and `myblog.blogspot.com`, but not for `com`, `co.uk`, `google.invalid`, or `blogspot.com`. This method can be used to determine whether it will probably be possible to set cookies on the domain, though even that depends on individual browsers' implementations of cookie controls. See RFC 2109 for details. Since 6.0

public boolean isUnderPublicSuffix()

Indicates whether this domain name ends in a public suffix, while not being a public suffix itself. For example, returns true for www.google.com, foo.co.uk and myblog.blogspot.com, but not for com, co.uk, google.invalid, or blogspot.com.

This method can be used to determine whether it will probably be possible to set cookies on the domain, though even that depends on individual browsers' implementations of cookie controls. See RFC 2109 for details.

Since: 6.0

isUnderRegistrySuffix back to summary

isUnderRegistrySuffix	back to summary
public boolean isUnderRegistrySuffix() Indicates whether this domain name ends in a registry suffix, while not being a registry suffix itself. For example, returns `true` for `www.google.com`, `foo.co.uk` and `blogspot.com`, but not for `com`, `co.uk`, or `google.invalid`. Since 23.3

public boolean isUnderRegistrySuffix()

Indicates whether this domain name ends in a registry suffix, while not being a registry suffix itself. For example, returns true for www.google.com, foo.co.uk and blogspot.com, but not for com, co.uk, or google.invalid.

Since: 23.3

isValid back to summary

isValid	back to summary
public static boolean isValid(String name) Indicates whether the argument is a syntactically valid domain name using lenient validation. Specifically, validation against RFC 3490 ("Internationalizing Domain Names in Applications") is skipped. The following two code snippets are equivalent: `domainName = InternetDomainName.isValid(name) ? InternetDomainName.from(name) : DEFAULT_DOMAIN;` `try { domainName = InternetDomainName.from(name); } catch (IllegalArgumentException e) { domainName = DEFAULT_DOMAIN; }` Since 8.0 (previously named `isValidLenient`)

public static boolean isValid(String name)

Indicates whether the argument is a syntactically valid domain name using lenient validation. Specifically, validation against RFC 3490 ("Internationalizing Domain Names in Applications") is skipped.

The following two code snippets are equivalent:

domainName = InternetDomainName.isValid(name)
    ? InternetDomainName.from(name)
    : DEFAULT_DOMAIN;

try {
  domainName = InternetDomainName.from(name);
} catch (IllegalArgumentException e) {
  domainName = DEFAULT_DOMAIN;
}

Since: 8.0 (previously named isValidLenient)

matchesType	back to summary
private static boolean matchesType(Optional<PublicSuffixType> desiredType, Optional<PublicSuffixType> actualType) If a `desiredType` is specified, returns true only if the `actualType` is identical. Otherwise, returns true as long as `actualType` is present.

parent back to summary

parent	back to summary
public InternetDomainName parent() Returns an `InternetDomainName` that is the immediate ancestor of this one; that is, the current domain with the leftmost part removed. For example, the parent of `www.google.com` is `google.com`. Exceptions IllegalStateException: if the domain has no parent, as determined by `hasParent`

public InternetDomainName parent()

Returns an InternetDomainName that is the immediate ancestor of this one; that is, the current domain with the leftmost part removed. For example, the parent of www.google.com is google.com.

Exceptions

IllegalStateException:: if the domain has no parent, as determined by hasParent

parts	back to summary
public ImmutableList<String> parts() Returns the individual components of this domain name, normalized to all lower case. For example, for the domain name `mail.google.com`, this method returns the list `["mail", "google", "com"]`.

publicSuffix back to summary

publicSuffix	back to summary
public InternetDomainName publicSuffix() Returns the public suffix portion of the domain name, or `null` if no public suffix is present. Annotations @CheckForNull Since 6.0

public InternetDomainName publicSuffix()

Returns the public suffix portion of the domain name, or null if no public suffix is present.

Annotations

@CheckForNull

Since

6.0

publicSuffixIndex	back to summary
private int publicSuffixIndex() The index in the `parts()` list at which the public suffix begins. For example, for the domain name `myblog.blogspot.co.uk`, the value would be 1 (the index of the `blogspot` part). The value is negative (specifically, `NO_SUFFIX_FOUND`) if no public suffix was found.

registrySuffix back to summary

registrySuffix	back to summary
public InternetDomainName registrySuffix() Returns the registry suffix portion of the domain name, or `null` if no registry suffix is present. Annotations @CheckForNull Since 23.3

public InternetDomainName registrySuffix()

Returns the registry suffix portion of the domain name, or null if no registry suffix is present.

Annotations

@CheckForNull

Since

23.3

registrySuffixIndex	back to summary
private int registrySuffixIndex() The index in the `parts()` list at which the registry suffix begins. For example, for the domain name `myblog.blogspot.co.uk`, the value would be 2 (the index of the `co` part). The value is negative (specifically, `NO_SUFFIX_FOUND`) if no registry suffix was found.

topDomainUnderRegistrySuffix back to summary

topDomainUnderRegistrySuffix	back to summary
public InternetDomainName topDomainUnderRegistrySuffix() Returns the portion of this domain name that is one level beneath the registry suffix. For example, for `x.adwords.google.co.uk` it returns `google.co.uk`, since `co.uk` is a registry suffix. Similarly, for `myblog.blogspot.com` it returns `blogspot.com`, since `com` is a registry suffix. If `isTopDomainUnderRegistrySuffix()` is true, the current domain name instance is returned. Warning This method should not be used to determine whether a domain is probably the highest level for which cookies may be set. Use `isTopPrivateDomain()` for that purpose. Exceptions IllegalStateException: if this domain does not end with a registry suffix Since 23.3

public InternetDomainName topDomainUnderRegistrySuffix()

Returns the portion of this domain name that is one level beneath the registry suffix. For example, for x.adwords.google.co.uk it returns google.co.uk, since co.uk is a registry suffix. Similarly, for myblog.blogspot.com it returns blogspot.com, since com is a registry suffix.

If isTopDomainUnderRegistrySuffix() is true, the current domain name instance is returned.

Warning

This method should not be used to determine whether a domain is probably the highest level for which cookies may be set. Use isTopPrivateDomain() for that purpose.

Exceptions

IllegalStateException:: if this domain does not end with a registry suffix

Since

23.3

topPrivateDomain back to summary

topPrivateDomain	back to summary
public InternetDomainName topPrivateDomain() Returns the portion of this domain name that is one level beneath the public suffix. For example, for `x.adwords.google.co.uk` it returns `google.co.uk`, since `co.uk` is a public suffix. Similarly, for `myblog.blogspot.com` it returns the same domain, `myblog.blogspot.com`, since `blogspot.com` is a public suffix. If `isTopPrivateDomain()` is true, the current domain name instance is returned. This method can be used to determine the probable highest level parent domain for which cookies may be set, though even that depends on individual browsers' implementations of cookie controls. Exceptions IllegalStateException: if this domain does not end with a public suffix Since 6.0

public InternetDomainName topPrivateDomain()

Returns the portion of this domain name that is one level beneath the public suffix. For example, for x.adwords.google.co.uk it returns google.co.uk, since co.uk is a public suffix. Similarly, for myblog.blogspot.com it returns the same domain, myblog.blogspot.com, since blogspot.com is a public suffix.

If isTopPrivateDomain() is true, the current domain name instance is returned.

This method can be used to determine the probable highest level parent domain for which cookies may be set, though even that depends on individual browsers' implementations of cookie controls.

Exceptions

IllegalStateException:: if this domain does not end with a public suffix

Since

6.0

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the domain name, normalized to all lower case. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the domain name, normalized to all lower case.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

validatePart back to summary

validatePart	back to summary
private static boolean validatePart(String part, boolean isFinalPart) Helper method for `validateSyntax(List)`. Validates that one part of a domain name is valid. Parameters part:String The domain name part to be validated isFinalPart:boolean Is this the final (rightmost) domain part? Returns:boolean Whether the part is valid

private static boolean validatePart(String part, boolean isFinalPart)

Helper method for validateSyntax(List). Validates that one part of a domain name is valid.

Parameters

part:String: The domain name part to be validated
isFinalPart:boolean: Is this the final (rightmost) domain part?

Returns:boolean

Whether the part is valid

validateSyntax back to summary

validateSyntax	back to summary
private static boolean validateSyntax(List<String> parts) Validation method used by `from` to ensure that the domain name is syntactically valid according to RFC 1035. Returns:boolean Is the domain name syntactically valid?

private static boolean validateSyntax(List<String> parts)

Validation method used by from to ensure that the domain name is syntactically valid according to RFC 1035.

Returns:boolean: Is the domain name syntactically valid?

public final Class InternetDomainName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail