org.bytedeco.javacpp.tools

Class Builder

java.lang.Object

org.bytedeco.javacpp.tools.Builder

public class Builder
extends java.lang.Object

The Builder is responsible for coordinating efforts between the Parser, the Generator, and the native compiler. It contains the main() method, and basically takes care of the tasks one would expect from a command line build tool, but can also be used programmatically by setting its properties and calling build().

Constructor Summary

Constructors

Constructor and Description
Builder() Default constructor that simply initializes everything.
Builder(Logger logger) Constructor that simply initializes everything.

Method Summary

Modifier and Type	Method and Description
java.io.File[]	build() Starts the build process and returns an array of File produced.
Builder	buildCommand(java.lang.String[] buildCommand) Sets the buildCommand field to the argument.
Builder	classesOrPackages(java.lang.String... classesOrPackages) Requests the classScanner to add a class or all classes from a package.
Builder	classPaths(java.lang.String... classPaths) Appends argument to the paths of the classScanner.
Builder	classPaths(java.lang.String classPaths) Splits argument with File.pathSeparator and appends result to paths of the classScanner.
Builder	clean(boolean clean) Sets the clean field to the argument.
Builder	compile(boolean compile) Sets the compile field to the argument.
Builder	compilerOptions(java.lang.String... options) Appends arguments to the compilerOptions field.
Builder	copyLibs(boolean copyLibs) Sets the copyLibs field to the argument.
Builder	copyResources(boolean copyResources) Sets the copyResources field to the argument.
Builder	deleteJniFiles(boolean deleteJniFiles) Sets the deleteJniFiles field to the argument.
Builder	encoding(java.lang.String encoding) Sets the encoding field to the argument.
Builder	environmentVariables(java.util.Map<java.lang.String,java.lang.String> environmentVariables) Sets the environmentVariables field to the argument.
Builder	generate(boolean generate) Sets the generate field to the argument.
Builder	header(boolean header) Sets the header field to the argument.
Builder	jarPrefix(java.lang.String jarPrefix) Sets the jarPrefix field to the argument.
static void	main(java.lang.String[] args) The terminal shell interface to the Builder.
Builder	outputDirectory(java.io.File outputDirectory) Sets the outputDirectory field to the argument.
Builder	outputDirectory(java.lang.String outputDirectory) Sets the outputDirectory field to the argument.
Builder	outputName(java.lang.String outputName) Sets the outputName field to the argument.
static void	printHelp() Simply prints out to the display the command line usage.
Builder	properties(java.util.Properties properties) Adds all the properties of the argument to the properties field.
Builder	properties(java.lang.String platform) Sets the properties field to the ones loaded from resources for the specified platform.
Builder	property(java.lang.String keyValue) Sets a property of the properties field, in either "key=value" or "key:value" format.
Builder	property(java.lang.String key, java.lang.String value) Sets a key/value pair property of the properties field.
Builder	propertyFile(java.io.File propertyFile) Sets the properties field to the ones loaded from the specified file.
Builder	propertyFile(java.lang.String filename) Sets the properties field to the ones loaded from the specified file.
Builder	workingDirectory(java.io.File workingDirectory) Sets the workingDirectory field to the argument.
Builder	workingDirectory(java.lang.String workingDirectory) Sets the workingDirectory field to the argument.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Default constructor that simply initializes everything.

Builder

public Builder(Logger logger)

Constructor that simply initializes everything.

Parameters:

logger - where to send messages

Method Detail

classPaths

public Builder classPaths(java.lang.String classPaths)

Splits argument with File.pathSeparator and appends result to paths of the classScanner.

classPaths

public Builder classPaths(java.lang.String... classPaths)

Appends argument to the paths of the classScanner.

encoding

public Builder encoding(java.lang.String encoding)

Sets the encoding field to the argument.

outputDirectory

public Builder outputDirectory(java.lang.String outputDirectory)

Sets the outputDirectory field to the argument.

outputDirectory

public Builder outputDirectory(java.io.File outputDirectory)

Sets the outputDirectory field to the argument.

clean

public Builder clean(boolean clean)

Sets the clean field to the argument.

generate

public Builder generate(boolean generate)

Sets the generate field to the argument.

compile

public Builder compile(boolean compile)

Sets the compile field to the argument.

deleteJniFiles

public Builder deleteJniFiles(boolean deleteJniFiles)

Sets the deleteJniFiles field to the argument.

header

public Builder header(boolean header)

Sets the header field to the argument.

copyLibs

public Builder copyLibs(boolean copyLibs)

Sets the copyLibs field to the argument.

copyResources

public Builder copyResources(boolean copyResources)

Sets the copyResources field to the argument.

outputName

public Builder outputName(java.lang.String outputName)

Sets the outputName field to the argument.

jarPrefix

public Builder jarPrefix(java.lang.String jarPrefix)

Sets the jarPrefix field to the argument.

properties

public Builder properties(java.lang.String platform)

Sets the properties field to the ones loaded from resources for the specified platform.

properties

public Builder properties(java.util.Properties properties)

Adds all the properties of the argument to the properties field.

propertyFile

public Builder propertyFile(java.lang.String filename)
                     throws java.io.IOException

Sets the properties field to the ones loaded from the specified file.

Throws:

java.io.IOException

propertyFile

public Builder propertyFile(java.io.File propertyFile)
                     throws java.io.IOException

Sets the properties field to the ones loaded from the specified file.

Throws:

java.io.IOException

property

public Builder property(java.lang.String keyValue)

Sets a property of the properties field, in either "key=value" or "key:value" format.

property

public Builder property(java.lang.String key,
                        java.lang.String value)

Sets a key/value pair property of the properties field.

classesOrPackages

public Builder classesOrPackages(java.lang.String... classesOrPackages)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException,
                                 java.lang.NoClassDefFoundError

Requests the classScanner to add a class or all classes from a package. A null argument indicates the unnamed package.

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.NoClassDefFoundError

buildCommand

public Builder buildCommand(java.lang.String[] buildCommand)

Sets the buildCommand field to the argument.

workingDirectory

public Builder workingDirectory(java.lang.String workingDirectory)

Sets the workingDirectory field to the argument.

workingDirectory

public Builder workingDirectory(java.io.File workingDirectory)

Sets the workingDirectory field to the argument.

environmentVariables

public Builder environmentVariables(java.util.Map<java.lang.String,java.lang.String> environmentVariables)

Sets the environmentVariables field to the argument.

compilerOptions

public Builder compilerOptions(java.lang.String... options)

Appends arguments to the compilerOptions field.

build

public java.io.File[] build()
                     throws java.io.IOException,
                            java.lang.InterruptedException,
                            ParserException

Starts the build process and returns an array of File produced.

Returns:

the array of File produced

Throws:

java.io.IOException

java.lang.InterruptedException

ParserException

printHelp

public static void printHelp()

Simply prints out to the display the command line usage.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

The terminal shell interface to the Builder.

Parameters:

args - an array of arguments as described by printHelp()

Throws:

java.lang.Exception