Struct JavaBuild

pub struct JavaBuild { /* private fields */ }

A builder for a javac command that can be invoked.

If you need to customize the javac command beyond what is provided here, you can use the JavaBuild::command() method to get a Command that can be further customized with additional arguments.

Documentation on javac options are based on https://dev.java/learn/jvm/tools/core/javac/.

Implementations

impl JavaBuild

pub fn new() -> Self

Creates a new JavaBuild instance with default values, which can be further customized using the builder methods.

pub fn compile(&self) -> Result<ExitStatus>

Executes the javac command based on this JavaBuild instance.

pub fn command(&self) -> Result<Command>

Returns a Command based on this JavaBuild instance that can be inspected or customized before being executed.

pub fn java_home<P: Into<PathBuf>>(&mut self, java_home: P) -> &mut Self

Override the default JAVA_HOME path.

If not set, the default path is found using the JAVA_HOME env var.

pub fn debug_info(&mut self, debug_info: DebugInfo) -> &mut Self

Set which debug info should be included in the generated class files

pub fn nowarn(&mut self, nowarn: bool) -> &mut Self

If set to true, all warnings are disabled.

pub fn verbose(&mut self, verbose: bool) -> &mut Self

Enable verbose output.

pub fn deprecation(&mut self, deprecation: bool) -> &mut Self

Configure the output about deprecation usage.

• If true, javac will output full descriptions of all places where deprecated members/classes are used or overridden.
• If false, javac will output only a summary on a per-source file basis.

pub fn enable_preview_features( &mut self, enable_preview_features: bool, ) -> &mut Self

Enable or disable preview language features.

pub fn class_path<P: AsRef<OsStr>>(&mut self, class_path: P) -> &mut Self

Specify where to find user class files and annotation processors.

If no class paths are provided, the current directory will be used.

pub fn source_path<P: AsRef<OsStr>>(&mut self, source_path: P) -> &mut Self

Specify where to find input source files.

If not specified, class_paths will be searched for source files.

pub fn boot_class_path<P: AsRef<OsStr>>( &mut self, boot_class_path: P, ) -> &mut Self

Specify where to find bootstrap class files.

If set, this will override the default search locations.

pub fn extension_dir<P: AsRef<OsStr>>(&mut self, extension_dir: P) -> &mut Self

Specify where to find installed extensions.

If set, this will override the default search locations.

pub fn endorsed_dir<P: AsRef<OsStr>>(&mut self, endorsed_dir: P) -> &mut Self

Specify where to find endorsed standards.

If set, this will override the default endorsed standards path.

pub fn annotation_processor<S: AsRef<OsStr>>( &mut self, annotation_processor: S, ) -> &mut Self

Add an annotation processor to be run during compilation.

Setting this will bypass the default discovery process.

pub fn annotation_processor_path<P: AsRef<OsStr>>( &mut self, annotation_processor_path: P, ) -> &mut Self

Add a path to search for annotation processors.

If not provided, the class paths will be searched by default.

pub fn method_paramater_metadata( &mut self, method_paramater_metadata: bool, ) -> &mut Self

Enable generation of metadata on method parameters such that the reflection API can be used to retrieve parameter info.

pub fn classes_out_dir<P: AsRef<OsStr>>( &mut self, classes_out_dir: P, ) -> &mut Self

Specify where to place generated class files.

If not provided, class files will be placed in the same directory as the source files.

pub fn sources_out_dir<P: AsRef<OsStr>>( &mut self, sources_out_dir: P, ) -> &mut Self

Specify where to place generated source files.

pub fn headers_out_dir<P: AsRef<OsStr>>( &mut self, headers_out_dir: P, ) -> &mut Self

Specify where to place generated native header files.

pub fn annotation_parameter<K, V>(&mut self, key: K, value: V) -> &mut Self

where K: Into<String>, V: Into<String>,

Add a key-value pair to be passed as an option to an annotation processor.

pub fn warnings_as_errors(&mut self, warnings_as_errors: bool) -> &mut Self

If set to true, warnings are treated as compilation errors.

pub fn file<P: AsRef<OsStr>>(&mut self, file: P) -> &mut Self

Adds a Java source file to be compiled by javac.

pub fn files<P>(&mut self, files: P) -> &mut Self

where P: IntoIterator, P::Item: AsRef<OsStr>,

Adds multiple Java source files to be compiled by javac.

This is the same as calling JavaBuild::file() multiple times.

Trait Implementations

impl Clone for JavaBuild

fn clone(&self) -> JavaBuild

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JavaBuild

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for JavaBuild

fn default() -> JavaBuild

Returns the “default value” for a type.