Skip to content

Commit

Permalink
Fix javadocs for Runfiles
Browse files Browse the repository at this point in the history
`Runfiles` insurance are cheap, `Preloaded` instances are costly.

Closes #23006.

PiperOrigin-RevId: 654661845
Change-Id: I46ee31718a2c5753d983b9c741547fe2a1de5d88
  • Loading branch information
fmeum authored and copybara-github committed Jul 22, 2024
1 parent af8deb8 commit 7d26615
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions tools/java/runfiles/Runfiles.java
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,10 @@
* Runfiles#preload(Map)} and immutably encapsulate all data required to look up runfiles with the
* repository mapping of any Bazel repository specified at a later time.
*
* <p>Creating {@link Runfiles} instances can be costly, so applications should try to create as few
* instances as possible. {@link Runfiles#preload()}, but not {@link Runfiles#preload(Map)}, returns
* a single global, softly cached instance of {@link Preloaded} that is constructed based on the
* JVM's environment variables.
* <p>Creating {@link Preloaded} instances can be costly, so applications should try to create as
* few instances as possible. {@link Runfiles#preload()}, but not {@link Runfiles#preload(Map)},
* returns a single global, softly cached instance of {@link Preloaded} that is constructed based on
* the JVM's environment variables.
*
* <p>Instance of {@link Runfiles} are only meant to be used by code located in a single Bazel
* repository and should not be passed around. They are created by calling {@link
Expand Down

0 comments on commit 7d26615

Please sign in to comment.