Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/google/guava

Google core libraries for Java
https://github.com/google/guava

guava java

Last synced: 6 days ago
JSON representation

Google core libraries for Java

Awesome Lists containing this project

README 

        
# Guava: Google Core Libraries for Java



[![Latest release](https://img.shields.io/github/release/google/guava.svg)](https://github.com/google/guava/releases/latest)

[![Build Status](https://github.com/google/guava/workflows/CI/badge.svg?branch=master)](https://github.com/google/guava/actions)

[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7197/badge)](https://bestpractices.coreinfrastructure.org/projects/7197)



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:



*   The JRE flavor requires JDK 1.8 or higher.

*   If you need support for Android, use

    [the Android flavor](https://github.com/google/guava/wiki/Android). You can

    find the Android Guava source in the [`android` directory].



[`android` directory]: https://github.com/google/guava/tree/master/android



## Adding Guava to your build



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 `33.4.0-jre` or

`33.4.0-android`. For more about depending on Guava, see

[using Guava in your build].



To add a dependency on Guava using Maven, use the following:



```xml



  com.google.guava

  guava

  33.4.0-jre

  

  33.4.0-android



```



To add a dependency using Gradle:



```gradle

dependencies {

  // Pick one:



  // 1. Use Guava in your implementation only:

  implementation("com.google.guava:guava:33.4.0-jre")



  // 2. Use Guava types in your public API:

  api("com.google.guava:guava:33.4.0-jre")



  // 3. Android - Use Guava in your implementation only:

  implementation("com.google.guava:guava:33.4.0-android")



  // 4. Android - Use Guava types in your public API:

  api("com.google.guava:guava:33.4.0-android")

}

```



For more information on when to use `api` and when to use `implementation`,

consult the

[Gradle documentation on API and implementation separation](https://docs.gradle.org/current/userguide/java_library_plugin.html#sec:java_library_separation).



## Snapshots and Documentation



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.



-   Snapshot API Docs: [guava][guava-snapshot-api-docs]

-   Snapshot API Diffs: [guava][guava-snapshot-api-diffs]



## Learn about Guava



-   Our users' guide, [Guava Explained]

-   [A nice collection](https://www.tfnico.com/presentations/google-guava) of

    other helpful links



## Links



-   [GitHub project](https://github.com/google/guava)

-   [Issue tracker: Report a defect or feature request](https://github.com/google/guava/issues/new)

-   [StackOverflow: Ask "how-to" and "why-didn't-it-work" questions](https://stackoverflow.com/questions/ask?tags=guava+java)

-   [guava-announce: Announcements of releases and upcoming significant changes](https://groups.google.com/group/guava-announce)

-   [guava-discuss: For open-ended questions and discussion](https://groups.google.com/group/guava-discuss)



## IMPORTANT WARNINGS



1.  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!**



2.  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).



3.  Guava has one dependency that is needed for linkage at runtime:

    `com.google.guava:failureaccess:1.0.2`. It also has

    [some annotation-only dependencies][guava-deps], which we discuss in more

    detail at that link.



4.  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.



5.  Our classes are not designed to protect against a malicious caller. You

    should not use them for communication between trusted and untrusted code.



6.  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 21 (Lollipop).



[guava-snapshot-api-docs]: https://guava.dev/releases/snapshot-jre/api/docs/

[guava-snapshot-api-diffs]: https://guava.dev/releases/snapshot-jre/api/diffs/

[Guava Explained]: https://github.com/google/guava/wiki/Home

[Guava Beta Checker]: https://github.com/google/guava-beta-checker



[using Guava in your build]: https://github.com/google/guava/wiki/UseGuavaInYourBuild

[repackage]: https://github.com/google/guava/wiki/UseGuavaInYourBuild#what-if-i-want-to-use-beta-apis-from-a-library-that-people-use-as-a-dependency

[guava-deps]: https://github.com/google/guava/wiki/UseGuavaInYourBuild#what-about-guavas-own-dependencies