commit | 5550ffc0e04fe8a3e8f128f692d37397232dae2b | [log] [tgz] |
---|---|---|
author | cpovirk <cpovirk@google.com> | Mon Oct 16 13:45:14 2023 -0700 |
committer | Google Java Core Libraries <java-core-libraries-team+copybara@google.com> | Mon Oct 16 13:48:20 2023 -0700 |
tree | ac2a624af80e31260b840f94624e95533cbb7802 | |
parent | e0292369fe4be9c51b12a68724302f38f03c0a5b [diff] |
Begin using Maven Wrapper. I set this up with: ``` mvn org.apache.maven.plugins:maven-wrapper-plugin:3.2.0:wrapper -Dtype=-script -Dmaven=3.9.5 ``` It's not obvious to me whether we'll notice many differences among the 3 non-binary types (`source`, `script`, and `only-script`). I initially went with `only-script`, which is newest, given that it sounded theoretically like it would involve the fewest steps. But I got [an error](https://github.com/google/guava/actions/runs/6536542346/job/17748480689?pr=6783) from the Windows CI: ``` distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found 'https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.5/apache-maven-3.9.5-bin.zip ' ``` I assume that this is a newline-related issue. That error message comes from the `only-script` shell script, and there is no such line in the `script` shell script, so I'm now trying `script`. (It's possible that we should be using `mvnw.cmd` under Windows, so maybe nothing will work until I change our CI to do that.... (We got a recommendation for the Maven Wrapper [from Ben Manes](https://groups.google.com/g/guava-discuss/c/e5UVvuM9CP8/m/w2H3CjZ7AQAJ).) There does not yet appear to be a way to [make Dependabot automatically update the version of Maven we use](https://github.com/dependabot/dependabot-core/issues/485) (nor the version of the wrapper itself, though I looked less hard for that because it's less important). We've already not kept up with Maven upgrades very carefully—and we might each be using different Maven versions for all I know!—so this isn't necessarily a huge downgrade. Still, we don't want to fall far behind what's on our machines or GitHub CI, so I've at least set myself a calendar reminder to check back every 6 months. RELNOTES=n/a PiperOrigin-RevId: 573917287
Guava is a set of core Java libraries from Google that includes new collection types (such as multimap and multiset), immutable collections, a graph library, and utilities for concurrency, I/O, hashing, primitives, strings, and more! It is widely used on most Java projects within Google, and widely used by many other companies as well.
Guava comes in two flavors:
android
directory.Guava's Maven group ID is com.google.guava
, and its artifact ID is guava
. Guava provides two different “flavors”: one for use on a (Java 8+) JRE and one for use on Android or by any library that wants to be compatible with Android. These flavors are specified in the Maven version field as either 32.1.3-jre
or 32.1.3-android
. For more about depending on Guava, see using Guava in your build.
To add a dependency on Guava using Maven, use the following:
<dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>32.1.3-jre</version> <!-- or, for Android: --> <version>32.1.3-android</version> </dependency>
To add a dependency using Gradle:
dependencies { // Pick one: // 1. Use Guava in your implementation only: implementation("com.google.guava:guava:32.1.3-jre") // 2. Use Guava types in your public API: api("com.google.guava:guava:32.1.3-jre") // 3. Android - Use Guava in your implementation only: implementation("com.google.guava:guava:32.1.3-android") // 4. Android - Use Guava types in your public API: api("com.google.guava:guava:32.1.3-android") }
For more information on when to use api
and when to use implementation
, consult the Gradle documentation on API and implementation separation.
Snapshots of Guava built from the master
branch are available through Maven using version HEAD-jre-SNAPSHOT
, or HEAD-android-SNAPSHOT
for the Android flavor.
APIs marked with the @Beta
annotation at the class or method level are subject to change. They can be modified in any way, or even removed, at any time. If your code is a library itself (i.e., it is used on the CLASSPATH of users outside your own control), you should not use beta APIs unless you repackage them. If your code is a library, we strongly recommend using the Guava Beta Checker to ensure that you do not use any @Beta
APIs!
APIs without @Beta
will remain binary-compatible for the indefinite future. (Previously, we sometimes removed such APIs after a deprecation period. The last release to remove non-@Beta
APIs was Guava 21.0.) Even @Deprecated
APIs will remain (again, unless they are @Beta
). We have no plans to start removing things again, but officially, we're leaving our options open in case of surprises (like, say, a serious security problem).
Guava has one dependency that is needed for linkage at runtime: com.google.guava:failureaccess:1.0.1
. It also has some annotation-only dependencies, which we discuss in more detail at that link.
Serialized forms of ALL objects are subject to change unless noted otherwise. Do not persist these and assume they can be read by a future version of the library.
Our classes are not designed to protect against a malicious caller. You should not use them for communication between trusted and untrusted code.
For the mainline flavor, we test the libraries using OpenJDK 8, 11, and 17 on Linux, with some additional testing on newer JDKs and on Windows. Some features, especially in com.google.common.io
, may not work correctly in non-Linux environments. For the Android flavor, our unit tests also run on API level 15 (Ice Cream Sandwich).