J2objcConfig (j2objc-gradle 0.3.0-alpha API)

com.github.j2objccontrib.j2objcgradle.J2objcConfig

Further configuration uses the following fields, setting them in j2objcConfig within build.gradle

Field Summary

Fields
Modifiers	Name	Description
`protected boolean`	`finalConfigured`
`protected NativeCompilation`	`nativeCompilation`
`protected org.gradle.api.Project`	`project`

Properties Summary

Properties
Type	Name and description
`boolean`	`UNSAFE_incrementalBuildClosure`
`java.util.List<java.lang.String>`	`cycleFinderArgs` Command line arguments for j2objc cycle_finder.
`int`	`cycleFinderExpectedCycles` Expected number of cycles, defaults to all those found in JRE.
`java.lang.String`	`destLibDir` Where to assemble generated main libraries.
`java.lang.String`	`destSrcDir` Where to assemble generated main source files.
`java.lang.String`	`destSrcDirTest` Where to assemble generated test source files.
`java.lang.String[]`	`extraLinkerArgs` Additional arguments to pass to the native linker.
`java.lang.String[]`	`extraObjcCompilerArgs` Additional arguments to pass to the native compiler.
`java.lang.String[]`	`extraObjcSrcDirs` Directories of Objective-C source to compile in addition to the translated source.
`boolean`	`filenameCollisionCheck` Makes sure that the translated filenames don't collide.
`java.util.List<java.lang.String>`	`generatedSourceDirs` Generated source files directories, e.g. from dagger annotations.
`java.util.List<java.lang.String>`	`supportedArchs` Which architectures will be built and supported in packed ('fat') libraries.
`java.util.List<java.lang.String>`	`testArgs` Command line arguments for j2objcTest task.
`int`	`testMinExpectedTests` j2objcTest will fail if it runs less than the expected number of tests; set to 0 to disable.
`org.gradle.api.tasks.util.PatternSet`	`testPattern` Filter on files to test.
`java.util.List<java.lang.String>`	`translateArgs` Command line arguments for j2objc translate.
`java.util.List<java.lang.String>`	`translateClassPaths` Libraries from ${projectDir}/lib/, e.g.: "json-20140107.jar", "somelib.jar".
`java.util.List<java.lang.String>`	`translateJ2objcLibs` Additional libraries that are part of the j2objc distribution.
`org.gradle.api.tasks.util.PatternSet`	`translatePattern` Sets the filter on files to translate.
`java.lang.String`	`translateSourcepaths` Additional sourcepaths to translate.
`java.lang.String`	`xcodeProjectDir` Directory of the target Xcode project.
`java.lang.String`	`xcodeTarget` Xcode target the generated files should be linked to.

Constructor Summary

Constructors
Constructor and description
`J2objcConfig (org.gradle.api.Project project)`

Methods Summary

Methods
Type	Name and description
`static void`	`appendArgs(java.util.List<java.lang.String> listArgs, java.lang.String nameArgs, java.lang.String... args)`
`void`	`cycleFinderArgs(java.lang.String... args)` Add command line arguments for j2objc cycle_finder.
`void`	`dependsOnJ2objcLib(java.lang.String beforeProjectName)` @see #dependsOnJ2objcLib(org.gradle.api.Project)
`void`	`dependsOnJ2objcLib(org.gradle.api.Project beforeProject)` Uses the generated headers and compiled j2objc libraries of the given project when compiling this project.
`void`	`extraLinkerArgs(java.lang.String... args)` Add arguments to pass to the native linker.
`void`	`extraObjcCompilerArgs(java.lang.String... args)` Add arguments to pass to the native compiler.
`void`	`extraObjcSrcDirs(java.lang.String... args)` Add directories of Objective-C source to compile in addition to the translated source.
`void`	`finalConfigure()` Configures the native build using.
`void`	`generatedSourceDirs(java.lang.String... args)` Add generated source files directories, e.g. from dagger annotations.
`boolean`	`isFinalConfigured()`
`void`	`testArgs(java.lang.String... args)` Add command line arguments for j2objcTest task.
`org.gradle.api.tasks.util.PatternSet`	`testPattern(groovy.lang.Closure cl)` Configures the testPattern Calling this method repeatedly further modifies the existing testPattern, and will create an empty testPattern if none exists.
`void`	`translateArgs(java.lang.String... args)` Add command line arguments for j2objc translate.
`void`	`translateClassPaths(java.lang.String... args)` Add libraries from ${projectDir}/lib/, e.g.: "json-20140107.jar", "somelib.jar".
`org.gradle.api.tasks.util.PatternSet`	`translatePattern(groovy.lang.Closure cl)` Configures the translatePattern.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected boolean finalConfigured
  - protected NativeCompilation nativeCompilation
  - protected final org.gradle.api.Project project
- Property Detail
  - boolean UNSAFE_incrementalBuildClosure
  - java.util.List<java.lang.String> cycleFinderArgs
    
    Command line arguments for j2objc cycle_finder.
    A list of all possible arguments can be found here: http://j2objc.org/docs/cycle_finder.html
  - int cycleFinderExpectedCycles
    
    Expected number of cycles, defaults to all those found in JRE.
    This is an exact number rather than minimum as any change is significant.
  - java.lang.String destLibDir
    
    Where to assemble generated main libraries.
    Defaults to $buildDir/j2objcOutputs/lib
  - java.lang.String destSrcDir
    
    Where to assemble generated main source files.
    Defaults to $buildDir/j2objcOutputs/src/main/objc
  - java.lang.String destSrcDirTest
    
    Where to assemble generated test source files.
    Can be the same directory as destDir Defaults to $buildDir/j2objcOutputs/src/test/objc
  - java.lang.String[] extraLinkerArgs
    
    Additional arguments to pass to the native linker.
  - java.lang.String[] extraObjcCompilerArgs
    
    Additional arguments to pass to the native compiler.
  - java.lang.String[] extraObjcSrcDirs
    
    Directories of Objective-C source to compile in addition to the translated source.
  - boolean filenameCollisionCheck
    
    Makes sure that the translated filenames don't collide.
    Recommended if you choose to use --no-package-directories.
  - java.util.List<java.lang.String> generatedSourceDirs
    
    Generated source files directories, e.g. from dagger annotations.
    The plugin will ignore changes in this directory so they must be limited to files generated solely from files within your main and/or test sourceSets.
  - java.util.List<java.lang.String> supportedArchs
    
    Which architectures will be built and supported in packed ('fat') libraries.
    The three ios_arm* architectures are for iPhone and iPad devices, while ios_i386 and ios_x86_64 are for their simulators.
    Adding an unrecognized new architecture here will fail.
    Removing an architecture here will cause that architecture not to be built and corresponding gradle tasks to not be created.
```
 supportedArchs = ['ios_arm64']  // Only build libraries for 64-bit iOS devices
 
```
    See Also:
    NativeCompilation.ALL_SUPPORTED_ARCHS
  - java.util.List<java.lang.String> testArgs
    
    Command line arguments for j2objcTest task.
  - int testMinExpectedTests
    
    j2objcTest will fail if it runs less than the expected number of tests; set to 0 to disable.
    It is a minimum so adding a unit test doesn't break the j2objc build.
  - org.gradle.api.tasks.util.PatternSet testPattern
    
    Filter on files to test. Note this has no effect on which tests are translated, just which tests are executed by the j2objcTest task.
    If no pattern is specified, all files within the 'test' sourceSet are translated.
    This filter is applied on top of all files within the 'main' and 'test' java sourceSets. Use testPattern(groovy.lang.Closure) to configure.
  - java.util.List<java.lang.String> translateArgs
    
    Command line arguments for j2objc translate.
    A list of all possible arguments can be found here: http://j2objc.org/docs/j2objc.html
  - java.util.List<java.lang.String> translateClassPaths
    
    Libraries from ${projectDir}/lib/, e.g.: "json-20140107.jar", "somelib.jar". This will be added to j2objc as a '-classpath' argument.
  - java.util.List<java.lang.String> translateJ2objcLibs
    
    Additional libraries that are part of the j2objc distribution.
  - org.gradle.api.tasks.util.PatternSet translatePattern
    
    Sets the filter on files to translate.
    If no pattern is specified, all files within the sourceSets are translated.
    This filter is applied on top of all files within the 'main' and 'test' java sourceSets. Use translatePattern(groovy.lang.Closure) to configure.
  - java.lang.String translateSourcepaths
    
    Additional sourcepaths to translate.
  - java.lang.String xcodeProjectDir
    
    Directory of the target Xcode project.
  - java.lang.String xcodeTarget
    
    Xcode target the generated files should be linked to.
- Constructor Detail
  - J2objcConfig(org.gradle.api.Project project)
- Method Detail
  - @com.google.common.annotations.VisibleForTesting static void appendArgs(java.util.List<java.lang.String> listArgs, java.lang.String nameArgs, java.lang.String... args)
  - void cycleFinderArgs(java.lang.String... args)
    
    Add command line arguments for j2objc cycle_finder.
    A list of all possible arguments can be found here: http://j2objc.org/docs/cycle_finder.html
    Parameters:
    cycleFinderArgs - add args for 'cycle_finder' tool
  - void dependsOnJ2objcLib(java.lang.String beforeProjectName)
    
    See Also:
    dependsOnJ2objcLib(org.gradle.api.Project)
  - void dependsOnJ2objcLib(org.gradle.api.Project beforeProject)
    
    Uses the generated headers and compiled j2objc libraries of the given project when compiling this project.
    Generally every cross-project 'compile' dependency should have a corresponding call to dependsOnJ2objcLib.
    It is safe to use this in conjunction with --build-closure.
    Do not also include beforeProject's java source or jar in the translateSourcepaths or translateClassPaths, respectively. Calling this method is preferable and sufficient.
  - void extraLinkerArgs(java.lang.String... args)
    
    Add arguments to pass to the native linker.
    Parameters:
    dirs - add arguments to pass to the native linker.
  - void extraObjcCompilerArgs(java.lang.String... args)
    
    Add arguments to pass to the native compiler.
    Parameters:
    dirs - add arguments to pass to the native compiler.
  - void extraObjcSrcDirs(java.lang.String... args)
    
    Add directories of Objective-C source to compile in addition to the translated source.
    Parameters:
    dirs - add directories for Objective-C source to be compiled
  - @com.google.common.annotations.VisibleForTesting void finalConfigure()
    
    Configures the native build using. Must be called at the very end of your j2objcConfig block.
  - void generatedSourceDirs(java.lang.String... args)
    
    Add generated source files directories, e.g. from dagger annotations.
    The plugin will ignore changes in this directory so they must be limited to files generated solely from files within your main and/or test sourceSets.
    Parameters:
    generatedSourceDirs - adds generated source directories for j2objc translate
  - boolean isFinalConfigured()
  - void testArgs(java.lang.String... args)
    
    Add command line arguments for j2objcTest task.
    Parameters:
    args - add args for the 'j2objcTest' task
  - org.gradle.api.tasks.util.PatternSet testPattern(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = PatternSet) groovy.lang.Closure cl)
    
    Configures the testPattern
    Calling this method repeatedly further modifies the existing testPattern, and will create an empty testPattern if none exists.
    For example:
```
 translatePattern {
     exclude 'CannotTranslateFileTest.java'
     exclude '**/CannotTranslateDir/*.java'
     include '**/CannotTranslateDir/AnExceptionToIncludeTest.java'
 }
 
```
    See Also:
    Gradle User Guide
  - void translateArgs(java.lang.String... args)
    
    Add command line arguments for j2objc translate.
    A list of all possible arguments can be found here: http://j2objc.org/docs/j2objc.html
    Parameters:
    translateArgs - add args for the 'j2objc' tool
  - void translateClassPaths(java.lang.String... args)
    
    Add libraries from ${projectDir}/lib/, e.g.: "json-20140107.jar", "somelib.jar". This will be added to j2objc as a '-classpath' argument.
    Parameters:
    add - libraries for -classpath argument
  - org.gradle.api.tasks.util.PatternSet translatePattern(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = PatternSet) groovy.lang.Closure cl)
    
    Configures the translatePattern.
    Calling this method repeatedly further modifies the existing translatePattern, and will create an empty translatePattern if none exists.
    For example:
```
 translatePattern {
     exclude 'CannotTranslateFile.java'
     exclude '**/CannotTranslateDir/*.java'
     include '**/CannotTranslateDir/AnExceptionToInclude.java'
 }
 
```
    See Also:
    Gradle User Guide

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class J2objcConfig

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected boolean finalConfigured

protected NativeCompilation nativeCompilation

protected final org.gradle.api.Project project

Property Detail

boolean UNSAFE_incrementalBuildClosure

java.util.List<java.lang.String> cycleFinderArgs

int cycleFinderExpectedCycles

java.lang.String destLibDir

java.lang.String destSrcDir

java.lang.String destSrcDirTest

java.lang.String[] extraLinkerArgs

java.lang.String[] extraObjcCompilerArgs

java.lang.String[] extraObjcSrcDirs

boolean filenameCollisionCheck

java.util.List<java.lang.String> generatedSourceDirs

java.util.List<java.lang.String> supportedArchs

java.util.List<java.lang.String> testArgs

int testMinExpectedTests

org.gradle.api.tasks.util.PatternSet testPattern

java.util.List<java.lang.String> translateArgs

java.util.List<java.lang.String> translateClassPaths

java.util.List<java.lang.String> translateJ2objcLibs

org.gradle.api.tasks.util.PatternSet translatePattern

java.lang.String translateSourcepaths

java.lang.String xcodeProjectDir

java.lang.String xcodeTarget

Constructor Detail

J2objcConfig(org.gradle.api.Project project)

Method Detail

@com.google.common.annotations.VisibleForTesting static void appendArgs(java.util.List<java.lang.String> listArgs, java.lang.String nameArgs, java.lang.String... args)

void cycleFinderArgs(java.lang.String... args)

void dependsOnJ2objcLib(java.lang.String beforeProjectName)

void dependsOnJ2objcLib(org.gradle.api.Project beforeProject)

void extraLinkerArgs(java.lang.String... args)

void extraObjcCompilerArgs(java.lang.String... args)

void extraObjcSrcDirs(java.lang.String... args)

@com.google.common.annotations.VisibleForTesting void finalConfigure()

void generatedSourceDirs(java.lang.String... args)

boolean isFinalConfigured()

void testArgs(java.lang.String... args)

org.gradle.api.tasks.util.PatternSet testPattern(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = PatternSet) groovy.lang.Closure cl)

void translateArgs(java.lang.String... args)

void translateClassPaths(java.lang.String... args)

org.gradle.api.tasks.util.PatternSet translatePattern(@groovy.lang.DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = PatternSet) groovy.lang.Closure cl)