Reorder the top-level declarations in the Package class

The declaration order of the elements in `Package.java` makes it even harder to figure out what is going on in this already monstrous (3k LOC) file. That order evolved over a very long time. This CL is an attempt to wrangle this complexity and unblock further cleanups, toward the goal of adding support for evaluation of individual symbolic macros.

(The drawback of this change is that it has a very large blast radius in terms of code line history / blame. I imagine I'll be sent many CL reviews by default for Package.java in the future...)

The new order for `Package`'s members is:

1. enums and static fields
2. instance fields -- metadata, then WORKSPACE-like fields, then targets/macros maps
3. accessors, in the same order as their corresponding fields (or where those fields will be after the follow-up CL). This includes a number of convenience accessors around subfields of the `metadata` field.
4. initialization logic - constructor, `finishInit()`, and a mutator only used in construction (I hope)
5. stringification
6. public static utility methods
7. non-trivial subclasses

with private helper methods sprinkled where appropriate. The order for `Package.Builder` and `Package.Metadata` elements is unchanged.

Other non-ordering changes:
- inlined `setPackageOverhead()`
- `getRepositoryMapping(RepositoryName)` was an overload of `getRepositoryMapping()`, but the former is intended for use only in `//external` while the latter is for normal `BUILD` packages. Renamed `getRepositoryMapping(RepositoryName)` -> `getExternalPackageRepositoryMapping(RepositoryName)`, which almost overloads an analogous method `getExternalPackageRepositoryMappings()` (note the missing 's').
- elaborated TODO for `setContainsErrors()`
- made `contextualizeFailureDetailForTarget` a static method, eliminated unneeded preconditions
- renamed static overload of `getSourceRoot` to `computeSourceRoot`; it belongs with `finishInit`, not the accessor
- inlined `createDetailedCode`

Work toward #19922.

PiperOrigin-RevId: 676094017
Change-Id: If2f779a6461b45c9c586653ee31f2f9dda7b71eb
4 files changed
tree: 70c3bec0390a8023de4b29c2869e05816dde6962
  1. .bazelci/
  2. .github/
  3. examples/
  4. scripts/
  5. site/
  6. src/
  7. third_party/
  8. tools/
  9. .bazelrc
  10. .bazelversion
  11. .gitattributes
  12. .gitignore
  13. AUTHORS
  14. bazel_downloader.cfg
  15. BUILD
  16. CHANGELOG.md
  17. CODE_OF_CONDUCT.md
  18. CODEOWNERS
  19. combine_distfiles.py
  20. combine_distfiles_to_tar.sh
  21. compile.sh
  22. CONTRIBUTING.md
  23. CONTRIBUTORS
  24. distdir.bzl
  25. extensions.bzl
  26. LICENSE
  27. maven_install.json
  28. MODULE.bazel
  29. MODULE.bazel.lock
  30. rbe_extension.bzl
  31. README.md
  32. repositories.bzl
  33. requirements.txt
  34. SECURITY.md
  35. WORKSPACE.bzlmod
  36. workspace_deps.bzl
README.md

Bazel

{Fast, Correct} - Choose two

Build and test software of any size, quickly and reliably.

  • Speed up your builds and tests: Bazel rebuilds only what is necessary. With advanced local and distributed caching, optimized dependency analysis and parallel execution, you get fast and incremental builds.

  • One tool, multiple languages: Build and test Java, C++, Android, iOS, Go, and a wide variety of other language platforms. Bazel runs on Windows, macOS, and Linux.

  • Scalable: Bazel helps you scale your organization, codebase, and continuous integration solution. It handles codebases of any size, in multiple repositories or a huge monorepo.

  • Extensible to your needs: Easily add support for new languages and platforms with Bazel's familiar extension language. Share and re-use language rules written by the growing Bazel community.

Getting Started

Documentation

Reporting a Vulnerability

To report a security issue, please email security@bazel.build with a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue. Our vulnerability management team will respond within 3 working days of your email. If the issue is confirmed as a vulnerability, we will open a Security Advisory. This project follows a 90 day disclosure timeline.

Contributing to Bazel

See CONTRIBUTING.md

Build status