com.android.jack.api.v01

Interface Api01Config

All Superinterfaces:

JackConfig

All Known Subinterfaces:

Api02Config, Api03Config, Api04Config

public interface Api01Config
extends JackConfig

A configuration for API level 01 of the Jack compiler.

Method Summary

Modifier and Type	Method and Description
Api01CompilationTask	getTask() Creates an instance of the Api01CompilationTask according to this configuration.
void	setClasspath(java.util.List<java.io.File> classpath) Sets the classpath.
void	setDebugInfoLevel(DebugInfoLevel debugInfoLevel) Set how much debug info should be emitted.
void	setImportedJackLibraryFiles(java.util.List<java.io.File> importedJackLibraryFiles) Sets the Jack library files that will be imported into the output.
void	setIncrementalDir(java.io.File incrementalDir) Sets the directory that will be used to store data for incremental support.
void	setJarJarConfigFiles(java.util.List<java.io.File> jarjarConfigFiles) Sets JarJar configuration files to use for repackaging.
void	setJavaSourceVersion(JavaSourceVersion javaSourceVersion) Sets the Java source version (from 3 to 7).
void	setMetaDirs(java.util.List<java.io.File> metaDirs) Sets the directories containing files to import into the output as meta-files.
void	setMultiDexKind(MultiDexKind multiDexKind) Sets whether to allow splitting the output in several dex files, and which method to use.
void	setObfuscationMappingOutputFile(java.io.File obfuscationMappingOutputFile) Sets the file where to write the obfuscation mapping.
void	setOutputDexDir(java.io.File outputDexDir) Sets the directory that will be used to write dex files and resources.
void	setOutputJackFile(java.io.File outputJackFile) Sets the file where the output Jack library will be written.
void	setProcessorNames(java.util.List<java.lang.String> processorNames) Sets the class names of the annotation processors to run.
void	setProcessorOptions(java.util.Map<java.lang.String,java.lang.String> processorOptions) Sets options for the annotation processors.
void	setProcessorPath(java.util.List<java.io.File> processorPath) Sets the path where to find annotation processors.
void	setProguardConfigFiles(java.util.List<java.io.File> proguardConfigFiles) Sets ProGuard configuration files.
void	setProperty(java.lang.String key, java.lang.String value) Sets the value for the given property.
void	setReporter(ReporterKind reporterKind, java.io.OutputStream reporterStream) Sets an OutputStream where Jack will write errors, warnings and other information.
void	setResourceDirs(java.util.List<java.io.File> resourceDirs) Sets the directories containing files to import into the output as resources.
void	setResourceImportCollisionPolicy(ResourceCollisionPolicy resourceImportCollisionPolicy) Sets the policy to follow when there is a collision between imported resources.
void	setSourceEntries(java.util.Collection<java.io.File> sourceEntries) Sets the Java source files entries to compile.
void	setTypeImportCollisionPolicy(TypeCollisionPolicy typeImportCollisionPolicy) Sets the policy to follow when there is a collision between imported types.
void	setVerbosityLevel(VerbosityLevel verbosityLevel) Sets the verbosity level.

Method Detail

setReporter

void setReporter(@Nonnull
                 ReporterKind reporterKind,
                 @Nonnull
                 java.io.OutputStream reporterStream)
          throws ConfigurationException

Sets an OutputStream where Jack will write errors, warnings and other information.

Parameters:

reporterKind - The type of reporter

reporterStream - The stream where to write

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setTypeImportCollisionPolicy

void setTypeImportCollisionPolicy(@Nonnull
                                  TypeCollisionPolicy typeImportCollisionPolicy)
                           throws ConfigurationException

Sets the policy to follow when there is a collision between imported types.

Parameters:

typeImportCollisionPolicy - the collision policy for imported types

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setResourceImportCollisionPolicy

void setResourceImportCollisionPolicy(@Nonnull
                                      ResourceCollisionPolicy resourceImportCollisionPolicy)
                               throws ConfigurationException

Sets the policy to follow when there is a collision between imported resources.

Parameters:

resourceImportCollisionPolicy - the collision policy for imported resources

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setJavaSourceVersion

void setJavaSourceVersion(@Nonnull
                          JavaSourceVersion javaSourceVersion)
                   throws ConfigurationException

Sets the Java source version (from 3 to 7).

Parameters:

javaSourceVersion - the Java source version

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setObfuscationMappingOutputFile

void setObfuscationMappingOutputFile(@Nonnull
                                     java.io.File obfuscationMappingOutputFile)
                              throws ConfigurationException

Sets the file where to write the obfuscation mapping. The file may already exist and will be overwritten.

Parameters:

obfuscationMappingOutputFile - the obfuscation mapping output file

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setClasspath

void setClasspath(@Nonnull
                  java.util.List<java.io.File> classpath)
           throws ConfigurationException

Sets the classpath.

Parameters:

classpath - The classpath as a list

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setImportedJackLibraryFiles

void setImportedJackLibraryFiles(@Nonnull
                                 java.util.List<java.io.File> importedJackLibraryFiles)
                          throws ConfigurationException

Sets the Jack library files that will be imported into the output.

Parameters:

importedJackLibraryFiles - The Jack library files to import

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setMetaDirs

void setMetaDirs(@Nonnull
                 java.util.List<java.io.File> metaDirs)
          throws ConfigurationException

Sets the directories containing files to import into the output as meta-files.

Parameters:

metaDirs - The directories containing the meta-files

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setResourceDirs

void setResourceDirs(@Nonnull
                     java.util.List<java.io.File> resourceDirs)
              throws ConfigurationException

Sets the directories containing files to import into the output as resources.

Parameters:

resourceDirs - The directories containing the resources

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setIncrementalDir

void setIncrementalDir(@Nonnull
                       java.io.File incrementalDir)
                throws ConfigurationException

Sets the directory that will be used to store data for incremental support. This directory must already exist.

Parameters:

incrementalDir - The directory used for incremental data

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setOutputDexDir

void setOutputDexDir(@Nonnull
                     java.io.File outputDexDir)
              throws ConfigurationException

Sets the directory that will be used to write dex files and resources. This directory must already exist.

Parameters:

outputDexDir - The output directory for dex files and resources

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setOutputJackFile

void setOutputJackFile(@Nonnull
                       java.io.File outputJackFile)
                throws ConfigurationException

Sets the file where the output Jack library will be written. The file may already exist and will be overwritten.

Parameters:

outputJackFile - The output Jack library file

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setJarJarConfigFiles

void setJarJarConfigFiles(@Nonnull
                          java.util.List<java.io.File> jarjarConfigFiles)
                   throws ConfigurationException

Sets JarJar configuration files to use for repackaging.

Parameters:

jarjarConfigFiles - The JarJar configuration files

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setProguardConfigFiles

void setProguardConfigFiles(@Nonnull
                            java.util.List<java.io.File> proguardConfigFiles)
                     throws ConfigurationException

Sets ProGuard configuration files.

Parameters:

proguardConfigFiles - The ProGuard configuration files

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setDebugInfoLevel

void setDebugInfoLevel(@Nonnull
                       DebugInfoLevel debugInfoLevel)
                throws ConfigurationException

Set how much debug info should be emitted.

Parameters:

debugInfoLevel - The level of debug info to emit

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setMultiDexKind

void setMultiDexKind(@Nonnull
                     MultiDexKind multiDexKind)
              throws ConfigurationException

Sets whether to allow splitting the output in several dex files, and which method to use.

Parameters:

multiDexKind - the multidex kind

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setVerbosityLevel

void setVerbosityLevel(@Nonnull
                       VerbosityLevel verbosityLevel)
                throws ConfigurationException

Sets the verbosity level.

Parameters:

verbosityLevel - the verbosity level

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setProcessorNames

void setProcessorNames(@Nonnull
                       java.util.List<java.lang.String> processorNames)
                throws ConfigurationException

Sets the class names of the annotation processors to run.

Parameters:

processorNames - Annotation processor class names

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setProcessorPath

void setProcessorPath(@Nonnull
                      java.util.List<java.io.File> processorPath)
               throws ConfigurationException

Sets the path where to find annotation processors.

Parameters:

processorPath - The processor path as a list

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setProcessorOptions

void setProcessorOptions(@Nonnull
                         java.util.Map<java.lang.String,java.lang.String> processorOptions)
                  throws ConfigurationException

Sets options for the annotation processors.

Parameters:

processorOptions - The processor options as a map

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setSourceEntries

void setSourceEntries(@Nonnull
                      java.util.Collection<java.io.File> sourceEntries)
               throws ConfigurationException

Sets the Java source files entries to compile.

Parameters:

sourceEntries - The source entries

Throws:

ConfigurationException - if something is wrong in Jack's configuration

setProperty

void setProperty(@Nonnull
                 java.lang.String key,
                 @Nonnull
                 java.lang.String value)
          throws ConfigurationException

Sets the value for the given property.

Parameters:

key - The name of the property

value - The value to set the property to

Throws:

ConfigurationException - if something is wrong in Jack's configuration

getTask

@Nonnull
Api01CompilationTask getTask()
                               throws ConfigurationException

Creates an instance of the Api01CompilationTask according to this configuration.

Returns:

The Api01CompilationTask

Throws:

ConfigurationException - if something is wrong in Jack's configuration