Bee API Overview
This page provides a concise overview of the available APIs, including their purpose, key functionalities, and usage patterns. It serves as a starting point for developers to understand how to integrate and interact with the system effectively.
🛠️ Interface
Help |
Provides help and information about Bee tasks, options, and environment. |
Java.Transporter |
Transporter between parent process and sub process. |
HeaderStyle |
no description |
FileType |
no description |
Maven |
no description |
Dependency |
Provides tasks for analyzing and displaying project dependencies. This includes showing the dependency tree and analyzing required Java modules. |
IDESupport |
no description |
Compile |
Compiles project source code, test code, and project-specific definition code. This task also handles copying associated resource files to the output directories. |
Intellij |
no description |
FindMain |
Provides tasks to find special entry point classes within the project: |
Bun |
no description |
Install |
no description |
Test |
no description |
IDE |
no description |
CI |
no description |
License |
no description |
Clean |
no description |
Eclipse |
no description |
Doc |
no description |
Native |
no description |
Wrapper |
no description |
Jar |
Handles the packaging of project artifacts (classes, sources, resources, documentation) into JAR files. |
Exe |
no description |
Prototype |
no description |
Task |
Defines the basic structure for all tasks within the Bee build system. |
VCS.Account |
Repository related model. |
🛠️ Functional Interface
Task.ValuedTaskReference |
Represents a type-safe reference to a task command that returns a value, typically implemented using a method reference (e.g., MyTask::getBuildResult). |
Task.TaskReference |
Represents a type-safe reference to a task command, typically implemented using a method reference (e.g., MyTask::myCommand). |
🛠️ Class
Platform |
Define platform specific default configurations. |
BeeOption |
no description |
PriorityClassLoader |
A ClassLoader that provides fine-grained control over class loading delegation. |
Process |
no description |
Profiling |
A thread-safe profiler for measuring the self-time execution of named code blocks, designed to work with nested scopes and parallel execution environments, potentially leveraging InheritableThreadLocal for parent scope tracking across threads (especially effective with virtual threads). |
Java |
no description |
JavaCompiler |
no description |
Inputs |
no description |
Compile.Config |
Configuration settings for the Compile task. These settings can be adjusted in the project definition file. |
AnnotationProcessor |
no description |
FindMain.Config |
Configuration class for the FindMain task, allowing users to explicitly specify the fully qualified names of the main, premain, and agentmain classes. If a value is set here, the automatic search might be skipped for that specific entry point. |
FindMain.Search |
Internal singleton service responsible for scanning project classes to find potential main, premain, and agentmain classes. |
Install.TemporaryProject |
no description |
Test.Junit |
no description |
Test.Config |
no description |
License.Config |
no description |
Eclipse.LombokInstaller |
no description |
Doc.Listener |
no description |
Native.Serialization |
no description |
Native.Config |
no description |
Wrapper.Config |
no description |
Jar.Config |
Configuration settings for the Jar task. |
Exe.Config |
no description |
Bee |
Bee is a task-based build tool for Java projects. It manages project compilation, dependency resolution, task execution, and provides user interaction through a UserInterface. |
TaskOperations |
no description |
Project |
no description |
ProjectSpecific |
no description |
License |
no description |
Loader |
Manages data transfers (downloading and uploading) and reports progress to the user interface. This class listens to Maven repository events (via AbstractRepositoryListener) and transfer events (via TransferListener) to provide real-time feedback on artifact resolution and deployment, as well as handling direct downloads via HTTP. |
VCS.Release |
Repository related model. |
VCS.Commit |
Repository related model. |
VCS.Content |
Repository related model. |
Library |
no description |
Repository |
no description |
BeeInstaller |
Handles the installation process for the Bee build tool. This includes installing the Bee executable JAR, creating launcher scripts, installing the Bee API into the local repository, and displaying a welcome message. |
🛠️ Enum
StandardHeaderStyle |
no description |
Scope |
no description |
🛠️ Annotation
Command |
no description |
Comment |
no description |
🛠️ Record
Native.Item |
no description |