Skip to content

Commit

Permalink
Avoid fully qualifying types from the same package, and use https.
Browse files Browse the repository at this point in the history
(pre-work for further `package-info` improvements)

RELNOTES=n/a
PiperOrigin-RevId: 540694363
  • Loading branch information
cpovirk authored and Google Java Core Libraries committed Jun 15, 2023
1 parent 6717a08 commit efede00
Show file tree
Hide file tree
Showing 30 changed files with 296 additions and 312 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
/**
* Testing utilities for use in tests of {@code com.google.common.escape}.
*
* <p>This package is a part of the open-source <a href="http://github.com/google/guava">Guava</a>
* <p>This package is a part of the open-source <a href="https://github.com/google/guava">Guava</a>
* library.
*/
@CheckReturnValue
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

/**
* This package contains testing utilities. It is a part of the open-source <a
* href="http://github.com/google/guava">Guava</a> library.
* href="https://github.com/google/guava">Guava</a> library.
*/
@com.google.errorprone.annotations.CheckReturnValue
@javax.annotation.ParametersAreNonnullByDefault
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@

/**
* Common annotation types. This package is a part of the open-source <a
* href="http://github.com/google/guava">Guava</a> library.
* href="https://github.com/google/guava">Guava</a> library.
*/
package com.google.common.annotations;
2 changes: 1 addition & 1 deletion android/guava/src/com/google/common/base/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
/**
* Basic utility libraries and interfaces.
*
* <p>This package is a part of the open-source <a href="http://github.com/google/guava">Guava</a>
* <p>This package is a part of the open-source <a href="https://github.com/google/guava">Guava</a>
* library.
*
* <h2>Contents</h2>
Expand Down
10 changes: 4 additions & 6 deletions android/guava/src/com/google/common/cache/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,14 @@
/**
* This package contains caching utilities.
*
* <p>The core interface used to represent caches is {@link com.google.common.cache.Cache}.
* In-memory caches can be configured and created using {@link
* com.google.common.cache.CacheBuilder}, with cache entries being loaded by {@link
* com.google.common.cache.CacheLoader}. Statistics about cache performance are exposed using {@link
* com.google.common.cache.CacheStats}.
* <p>The core interface used to represent caches is {@link Cache}. In-memory caches can be
* configured and created using {@link CacheBuilder}, with cache entries being loaded by {@link
* CacheLoader}. Statistics about cache performance are exposed using {@link CacheStats}.
*
* <p>See the Guava User Guide article on <a
* href="https://github.com/google/guava/wiki/CachesExplained">caches</a>.
*
* <p>This package is a part of the open-source <a href="http://github.com/google/guava">Guava</a>
* <p>This package is a part of the open-source <a href="https://github.com/google/guava">Guava</a>
* library.
*
* @author Charles Fry
Expand Down
221 changes: 109 additions & 112 deletions android/guava/src/com/google/common/collect/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,45 +17,43 @@
/**
* This package contains generic collection interfaces and implementations, and other utilities for
* working with collections. It is a part of the open-source <a
* href="http://github.com/google/guava">Guava</a> library.
* href="https://github.com/google/guava">Guava</a> library.
*
* <h2>Collection Types</h2>
*
* <dl>
* <dt>{@link com.google.common.collect.BiMap}
* <dt>{@link BiMap}
* <dd>An extension of {@link java.util.Map} that guarantees the uniqueness of its values as well
* as that of its keys. This is sometimes called an "invertible map," since the restriction on
* values enables it to support an {@linkplain com.google.common.collect.BiMap#inverse inverse
* view} -- which is another instance of {@code BiMap}.
* <dt>{@link com.google.common.collect.Multiset}
* values enables it to support an {@linkplain BiMap#inverse inverse view} -- which is another
* instance of {@code BiMap}.
* <dt>{@link Multiset}
* <dd>An extension of {@link java.util.Collection} that may contain duplicate values like a
* {@link java.util.List}, yet has order-independent equality like a {@link java.util.Set}.
* One typical use for a multiset is to represent a histogram.
* <dt>{@link com.google.common.collect.Multimap}
* <dt>{@link Multimap}
* <dd>A new type, which is similar to {@link java.util.Map}, but may contain multiple entries
* with the same key. Some behaviors of {@link com.google.common.collect.Multimap} are left
* unspecified and are provided only by the subtypes mentioned below.
* <dt>{@link com.google.common.collect.ListMultimap}
* <dd>An extension of {@link com.google.common.collect.Multimap} which permits duplicate entries,
* supports random access of values for a particular key, and has <i>partially order-dependent
* equality</i> as defined by {@link com.google.common.collect.ListMultimap#equals(Object)}.
* {@code ListMultimap} takes its name from the fact that the {@linkplain
* com.google.common.collect.ListMultimap#get collection of values} associated with a given
* key fulfills the {@link java.util.List} contract.
* <dt>{@link com.google.common.collect.SetMultimap}
* <dd>An extension of {@link com.google.common.collect.Multimap} which has order-independent
* equality and does not allow duplicate entries; that is, while a key may appear twice in a
* {@code SetMultimap}, each must map to a different value. {@code SetMultimap} takes its name
* from the fact that the {@linkplain com.google.common.collect.SetMultimap#get collection of
* values} associated with a given key fulfills the {@link java.util.Set} contract.
* <dt>{@link com.google.common.collect.SortedSetMultimap}
* <dd>An extension of {@link com.google.common.collect.SetMultimap} for which the {@linkplain
* com.google.common.collect.SortedSetMultimap#get collection values} associated with a given
* key is a {@link java.util.SortedSet}.
* <dt>{@link com.google.common.collect.Table}
* with the same key. Some behaviors of {@link Multimap} are left unspecified and are provided
* only by the subtypes mentioned below.
* <dt>{@link ListMultimap}
* <dd>An extension of {@link Multimap} which permits duplicate entries, supports random access of
* values for a particular key, and has <i>partially order-dependent equality</i> as defined
* by {@link ListMultimap#equals(Object)}. {@code ListMultimap} takes its name from the fact
* that the {@linkplain ListMultimap#get collection of values} associated with a given key
* fulfills the {@link java.util.List} contract.
* <dt>{@link SetMultimap}
* <dd>An extension of {@link Multimap} which has order-independent equality and does not allow
* duplicate entries; that is, while a key may appear twice in a {@code SetMultimap}, each
* must map to a different value. {@code SetMultimap} takes its name from the fact that the
* {@linkplain SetMultimap#get collection of values} associated with a given key fulfills the
* {@link java.util.Set} contract.
* <dt>{@link SortedSetMultimap}
* <dd>An extension of {@link SetMultimap} for which the {@linkplain SortedSetMultimap#get
* collection values} associated with a given key is a {@link java.util.SortedSet}.
* <dt>{@link Table}
* <dd>A new type, which is similar to {@link java.util.Map}, but which indexes its values by an
* ordered pair of keys, a row key and column key.
* <dt>{@link com.google.common.collect.ClassToInstanceMap}
* <dt>{@link ClassToInstanceMap}
* <dd>An extension of {@link java.util.Map} that associates a raw type with an instance of that
* type.
* </dl>
Expand All @@ -65,151 +63,150 @@
* <h3>of {@link java.util.List}</h3>
*
* <ul>
* <li>{@link com.google.common.collect.ImmutableList}
* <li>{@link ImmutableList}
* </ul>
*
* <h3>of {@link java.util.Set}</h3>
*
* <ul>
* <li>{@link com.google.common.collect.ImmutableSet}
* <li>{@link com.google.common.collect.ImmutableSortedSet}
* <li>{@link com.google.common.collect.ContiguousSet} (see {@code Range})
* <li>{@link ImmutableSet}
* <li>{@link ImmutableSortedSet}
* <li>{@link ContiguousSet} (see {@code Range})
* </ul>
*
* <h3>of {@link java.util.Map}</h3>
*
* <ul>
* <li>{@link com.google.common.collect.ImmutableMap}
* <li>{@link com.google.common.collect.ImmutableSortedMap}
* <li>{@link com.google.common.collect.MapMaker}
* <li>{@link ImmutableMap}
* <li>{@link ImmutableSortedMap}
* <li>{@link MapMaker}
* </ul>
*
* <h3>of {@link com.google.common.collect.BiMap}</h3>
* <h3>of {@link BiMap}</h3>
*
* <ul>
* <li>{@link com.google.common.collect.ImmutableBiMap}
* <li>{@link com.google.common.collect.HashBiMap}
* <li>{@link com.google.common.collect.EnumBiMap}
* <li>{@link com.google.common.collect.EnumHashBiMap}
* <li>{@link ImmutableBiMap}
* <li>{@link HashBiMap}
* <li>{@link EnumBiMap}
* <li>{@link EnumHashBiMap}
* </ul>
*
* <h3>of {@link com.google.common.collect.Multiset}</h3>
* <h3>of {@link Multiset}</h3>
*
* <ul>
* <li>{@link com.google.common.collect.ImmutableMultiset}
* <li>{@link com.google.common.collect.ImmutableSortedMultiset}
* <li>{@link com.google.common.collect.HashMultiset}
* <li>{@link com.google.common.collect.LinkedHashMultiset}
* <li>{@link com.google.common.collect.TreeMultiset}
* <li>{@link com.google.common.collect.EnumMultiset}
* <li>{@link com.google.common.collect.ConcurrentHashMultiset}
* <li>{@link ImmutableMultiset}
* <li>{@link ImmutableSortedMultiset}
* <li>{@link HashMultiset}
* <li>{@link LinkedHashMultiset}
* <li>{@link TreeMultiset}
* <li>{@link EnumMultiset}
* <li>{@link ConcurrentHashMultiset}
* </ul>
*
* <h3>of {@link com.google.common.collect.Multimap}</h3>
* <h3>of {@link Multimap}</h3>
*
* <ul>
* <li>{@link com.google.common.collect.ImmutableMultimap}
* <li>{@link com.google.common.collect.ImmutableListMultimap}
* <li>{@link com.google.common.collect.ImmutableSetMultimap}
* <li>{@link com.google.common.collect.ArrayListMultimap}
* <li>{@link com.google.common.collect.HashMultimap}
* <li>{@link com.google.common.collect.TreeMultimap}
* <li>{@link com.google.common.collect.LinkedHashMultimap}
* <li>{@link com.google.common.collect.LinkedListMultimap}
* <li>{@link ImmutableMultimap}
* <li>{@link ImmutableListMultimap}
* <li>{@link ImmutableSetMultimap}
* <li>{@link ArrayListMultimap}
* <li>{@link HashMultimap}
* <li>{@link TreeMultimap}
* <li>{@link LinkedHashMultimap}
* <li>{@link LinkedListMultimap}
* </ul>
*
* <h3>of {@link com.google.common.collect.Table}</h3>
* <h3>of {@link Table}</h3>
*
* <ul>
* <li>{@link com.google.common.collect.ImmutableTable}
* <li>{@link com.google.common.collect.ArrayTable}
* <li>{@link com.google.common.collect.HashBasedTable}
* <li>{@link com.google.common.collect.TreeBasedTable}
* <li>{@link ImmutableTable}
* <li>{@link ArrayTable}
* <li>{@link HashBasedTable}
* <li>{@link TreeBasedTable}
* </ul>
*
* <h3>of {@link com.google.common.collect.ClassToInstanceMap}</h3>
* <h3>of {@link ClassToInstanceMap}</h3>
*
* <ul>
* <li>{@link com.google.common.collect.ImmutableClassToInstanceMap}
* <li>{@link com.google.common.collect.MutableClassToInstanceMap}
* <li>{@link ImmutableClassToInstanceMap}
* <li>{@link MutableClassToInstanceMap}
* </ul>
*
* <h2>Classes of static utility methods</h2>
*
* <ul>
* <li>{@link com.google.common.collect.Collections2}
* <li>{@link com.google.common.collect.Iterators}
* <li>{@link com.google.common.collect.Iterables}
* <li>{@link com.google.common.collect.Lists}
* <li>{@link com.google.common.collect.Maps}
* <li>{@link com.google.common.collect.Queues}
* <li>{@link com.google.common.collect.Sets}
* <li>{@link com.google.common.collect.Multisets}
* <li>{@link com.google.common.collect.Multimaps}
* <li>{@link com.google.common.collect.Tables}
* <li>{@link com.google.common.collect.ObjectArrays}
* <li>{@link Collections2}
* <li>{@link Iterators}
* <li>{@link Iterables}
* <li>{@link Lists}
* <li>{@link Maps}
* <li>{@link Queues}
* <li>{@link Sets}
* <li>{@link Multisets}
* <li>{@link Multimaps}
* <li>{@link Tables}
* <li>{@link ObjectArrays}
* </ul>
*
* <h2>Comparison</h2>
*
* <ul>
* <li>{@link com.google.common.collect.Ordering}
* <li>{@link com.google.common.collect.ComparisonChain}
* <li>{@link Ordering}
* <li>{@link ComparisonChain}
* </ul>
*
* <h2>Abstract implementations</h2>
*
* <ul>
* <li>{@link com.google.common.collect.AbstractIterator}
* <li>{@link com.google.common.collect.AbstractSequentialIterator}
* <li>{@link com.google.common.collect.ImmutableCollection}
* <li>{@link com.google.common.collect.UnmodifiableIterator}
* <li>{@link com.google.common.collect.UnmodifiableListIterator}
* <li>{@link AbstractIterator}
* <li>{@link AbstractSequentialIterator}
* <li>{@link ImmutableCollection}
* <li>{@link UnmodifiableIterator}
* <li>{@link UnmodifiableListIterator}
* </ul>
*
* <h2>Ranges</h2>
*
* <ul>
* <li>{@link com.google.common.collect.Range}
* <li>{@link com.google.common.collect.RangeMap}
* <li>{@link com.google.common.collect.DiscreteDomain}
* <li>{@link com.google.common.collect.ContiguousSet}
* <li>{@link Range}
* <li>{@link RangeMap}
* <li>{@link DiscreteDomain}
* <li>{@link ContiguousSet}
* </ul>
*
* <h2>Other</h2>
*
* <ul>
* <li>{@link com.google.common.collect.Interner}, {@link com.google.common.collect.Interners}
* <li>{@link com.google.common.collect.MapDifference}, {@link
* com.google.common.collect.SortedMapDifference}
* <li>{@link com.google.common.collect.MinMaxPriorityQueue}
* <li>{@link com.google.common.collect.PeekingIterator}
* <li>{@link Interner}, {@link Interners}
* <li>{@link MapDifference}, {@link SortedMapDifference}
* <li>{@link MinMaxPriorityQueue}
* <li>{@link PeekingIterator}
* </ul>
*
* <h2>Forwarding collections</h2>
*
* <ul>
* <li>{@link com.google.common.collect.ForwardingCollection}
* <li>{@link com.google.common.collect.ForwardingConcurrentMap}
* <li>{@link com.google.common.collect.ForwardingIterator}
* <li>{@link com.google.common.collect.ForwardingList}
* <li>{@link com.google.common.collect.ForwardingListIterator}
* <li>{@link com.google.common.collect.ForwardingListMultimap}
* <li>{@link com.google.common.collect.ForwardingMap}
* <li>{@link com.google.common.collect.ForwardingMapEntry}
* <li>{@link com.google.common.collect.ForwardingMultimap}
* <li>{@link com.google.common.collect.ForwardingMultiset}
* <li>{@link com.google.common.collect.ForwardingNavigableMap}
* <li>{@link com.google.common.collect.ForwardingNavigableSet}
* <li>{@link com.google.common.collect.ForwardingObject}
* <li>{@link com.google.common.collect.ForwardingQueue}
* <li>{@link com.google.common.collect.ForwardingSet}
* <li>{@link com.google.common.collect.ForwardingSetMultimap}
* <li>{@link com.google.common.collect.ForwardingSortedMap}
* <li>{@link com.google.common.collect.ForwardingSortedMultiset}
* <li>{@link com.google.common.collect.ForwardingSortedSet}
* <li>{@link com.google.common.collect.ForwardingSortedSetMultimap}
* <li>{@link com.google.common.collect.ForwardingTable}
* <li>{@link ForwardingCollection}
* <li>{@link ForwardingConcurrentMap}
* <li>{@link ForwardingIterator}
* <li>{@link ForwardingList}
* <li>{@link ForwardingListIterator}
* <li>{@link ForwardingListMultimap}
* <li>{@link ForwardingMap}
* <li>{@link ForwardingMapEntry}
* <li>{@link ForwardingMultimap}
* <li>{@link ForwardingMultiset}
* <li>{@link ForwardingNavigableMap}
* <li>{@link ForwardingNavigableSet}
* <li>{@link ForwardingObject}
* <li>{@link ForwardingQueue}
* <li>{@link ForwardingSet}
* <li>{@link ForwardingSetMultimap}
* <li>{@link ForwardingSortedMap}
* <li>{@link ForwardingSortedMultiset}
* <li>{@link ForwardingSortedSet}
* <li>{@link ForwardingSortedSetMultimap}
* <li>{@link ForwardingTable}
* </ul>
*/
@CheckReturnValue
Expand Down
4 changes: 2 additions & 2 deletions android/guava/src/com/google/common/escape/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@

/**
* Interfaces, utilities, and simple implementations of escapers and encoders. The primary type is
* {@link com.google.common.escape.Escaper}.
* {@link Escaper}.
*
* <p>Additional escapers implementations are found in the applicable packages: {@link
* com.google.common.html.HtmlEscapers} in {@code com.google.common.html}, {@link
* com.google.common.xml.XmlEscapers} in {@code com.google.common.xml}, and {@link
* com.google.common.net.UrlEscapers} in {@code com.google.common.net}.
*
* <p>This package is a part of the open-source <a href="http://github.com/google/guava">Guava</a>
* <p>This package is a part of the open-source <a href="https://github.com/google/guava">Guava</a>
* library.
*/
@CheckReturnValue
Expand Down
2 changes: 1 addition & 1 deletion android/guava/src/com/google/common/html/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* for
* HTML.
*
* <p>This package is a part of the open-source <a href="http://github.com/google/guava">Guava</a>
* <p>This package is a part of the open-source <a href="https://github.com/google/guava">Guava</a>
* library.
*/
@CheckReturnValue
Expand Down
Loading

0 comments on commit efede00

Please sign in to comment.