NativeImageOptions (micronaut-gradle-plugin 1.0.0.RC7 API)

All Known Implementing Classes:

NativeImageTask
```
public interface NativeImageOptions
```
Interface that declares native image options.

Since:

1.0.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NativeImageOptions`	`args(java.lang.Iterable<?> args)` Adds args for the main class to be executed.
`NativeImageOptions`	`args(java.lang.Object... args)` Adds args for the main class to be executed.
`NativeImageOptions`	`classpath(java.lang.Object... paths)` Adds elements to the classpath for executing the main class.
`NativeImageOptions`	`debug(boolean debug)` Builds a native image with debug symbols
`NativeImageOptions`	`enableServerBuild(boolean enabled)` Enables server build.
`NativeImageOptions`	`fallback(boolean fallback)` Sets whether to enable a fallback or not
`org.gradle.api.file.FileCollection`	`getClasspath()` Returns the classpath for executing the main class.
`org.gradle.api.provider.Property<java.lang.String>`	`getImageName()` Gets the name of the native executable to be generated.
`org.gradle.api.provider.ListProperty<java.lang.String>`	`getJvmArgs()` Returns the extra arguments to use to launch the JVM for the process.
`org.gradle.api.provider.Property<java.lang.String>`	`getMain()` Returns the fully qualified name of the Main class to be executed.
`org.gradle.api.provider.MapProperty<java.lang.String,java.lang.Object>`	`getSystemProperties()` Returns the system properties which will be used for the process.
`org.gradle.api.provider.Property<java.lang.Boolean>`	`isDebug()`
`org.gradle.api.provider.Property<java.lang.Boolean>`	`isFallback()`
`org.gradle.api.provider.Property<java.lang.Boolean>`	`isServerBuild()`
`org.gradle.api.provider.Property<java.lang.Boolean>`	`isVerbose()`
`NativeImageOptions`	`jvmArgs(java.lang.Iterable<?> arguments)` Adds some arguments to use to launch the JVM for the process.
`NativeImageOptions`	`jvmArgs(java.lang.Object... arguments)` Adds some arguments to use to launch the JVM for the process.
`NativeImageOptions`	`setArgs(java.lang.Iterable<?> args)` Sets the args for the main class to be executed.
`NativeImageOptions`	`setArgs(java.util.List<java.lang.String> args)` Sets the args for the main class to be executed.
`NativeImageOptions`	`setClasspath(org.gradle.api.file.FileCollection classpath)` Sets the classpath for executing the main class.
`NativeImageOptions`	`setImageName(java.lang.String name)` Sets the name of the native executable to be generated.
`void`	`setJvmArgs(java.lang.Iterable<?> arguments)` Sets the extra arguments to use to launch the JVM for the process.
`void`	`setJvmArgs(java.util.List<java.lang.String> arguments)` Sets the extra arguments to use to launch the JVM for the process.
`NativeImageOptions`	`setMain(java.lang.String main)` Sets the fully qualified name of the main class to be executed.
`void`	`setSystemProperties(java.util.Map<java.lang.String,?> properties)` Sets the system properties to use for the process.
`NativeImageOptions`	`systemProperties(java.util.Map<java.lang.String,?> properties)` Adds some system properties to use for the process.
`NativeImageOptions`	`systemProperty(java.lang.String name, java.lang.Object value)` Adds a system property to use for the process.
`NativeImageOptions`	`verbose(boolean verbose)` Sets the native image build to be verbose

- Method Detail
  - isFallback
```
org.gradle.api.provider.Property<java.lang.Boolean> isFallback()
```
    Returns:
    
    Whether to enable fallbacks (defaults to false).
  - getImageName
```
@Input
org.gradle.api.provider.Property<java.lang.String> getImageName()
```
    Gets the name of the native executable to be generated.
  - setImageName
```
NativeImageOptions setImageName(@Nullable
                                java.lang.String name)
```
    Sets the name of the native executable to be generated.
    
    Parameters:
    
    name - The name.
    
    Returns:
    
    this
  - getMain
```
@Input
org.gradle.api.provider.Property<java.lang.String> getMain()
```
    Returns the fully qualified name of the Main class to be executed.
    This does not need to be set if using an Executable Jar with a Main-Class attribute.
  - setMain
```
NativeImageOptions setMain(@Nullable
                           java.lang.String main)
```
    Sets the fully qualified name of the main class to be executed.
    
    Parameters:
    
    main - the fully qualified name of the main class to be executed.
    
    Returns:
    
    this
  - args
```
NativeImageOptions args(java.lang.Object... args)
```
    Adds args for the main class to be executed.
    
    Parameters:
    
    args - Args for the main class.
    
    Returns:
    
    this
  - args
```
NativeImageOptions args(java.lang.Iterable<?> args)
```
    Adds args for the main class to be executed.
    
    Parameters:
    
    args - Args for the main class.
    
    Returns:
    
    this
  - setArgs
```
NativeImageOptions setArgs(@Nullable
                           java.util.List<java.lang.String> args)
```
    Sets the args for the main class to be executed.
    
    Parameters:
    
    args - Args for the main class.
    
    Returns:
    
    this
    
    Since:
    
    4.0
  - setArgs
```
NativeImageOptions setArgs(@Nullable
                           java.lang.Iterable<?> args)
```
    Sets the args for the main class to be executed.
    
    Parameters:
    
    args - Args for the main class.
    
    Returns:
    
    this
  - getSystemProperties
```
@Input
org.gradle.api.provider.MapProperty<java.lang.String,java.lang.Object> getSystemProperties()
```
    Returns the system properties which will be used for the process.
    
    Returns:
    
    The system properties. Returns an empty map when there are no system properties.
  - setSystemProperties
```
void setSystemProperties(java.util.Map<java.lang.String,?> properties)
```
    Sets the system properties to use for the process.
    
    Parameters:
    
    properties - The system properties. Must not be null.
  - systemProperties
```
NativeImageOptions systemProperties(java.util.Map<java.lang.String,?> properties)
```
    Adds some system properties to use for the process.
    
    Parameters:
    
    properties - The system properties. Must not be null.
    
    Returns:
    
    this
  - systemProperty
```
NativeImageOptions systemProperty(java.lang.String name,
                                  java.lang.Object value)
```
    Adds a system property to use for the process.
    
    Parameters:
    
    name - The name of the property
    
    value - The value for the property. May be null.
    
    Returns:
    
    this
  - classpath
```
NativeImageOptions classpath(java.lang.Object... paths)
```
    Adds elements to the classpath for executing the main class.
    
    Parameters:
    
    paths - classpath elements
    
    Returns:
    
    this
  - getClasspath
```
@Classpath
org.gradle.api.file.FileCollection getClasspath()
```
    Returns the classpath for executing the main class.
  - setClasspath
```
NativeImageOptions setClasspath(org.gradle.api.file.FileCollection classpath)
```
    Sets the classpath for executing the main class.
    
    Parameters:
    
    classpath - the classpath
    
    Returns:
    
    this
  - getJvmArgs
```
@Input
org.gradle.api.provider.ListProperty<java.lang.String> getJvmArgs()
```
    Returns the extra arguments to use to launch the JVM for the process. Does not include system properties and the minimum/maximum heap size.
    
    Returns:
    
    The arguments. Returns an empty list if there are no arguments.
  - setJvmArgs
```
void setJvmArgs(@Nullable
                java.util.List<java.lang.String> arguments)
```
    Sets the extra arguments to use to launch the JVM for the process. System properties and minimum/maximum heap size are updated.
    
    Parameters:
    
    arguments - The arguments. Must not be null.
    
    Since:
    
    4.0
  - setJvmArgs
```
void setJvmArgs(@Nullable
                java.lang.Iterable<?> arguments)
```
    Sets the extra arguments to use to launch the JVM for the process. System properties and minimum/maximum heap size are updated.
    
    Parameters:
    
    arguments - The arguments. Must not be null.
  - jvmArgs
```
NativeImageOptions jvmArgs(java.lang.Iterable<?> arguments)
```
    Adds some arguments to use to launch the JVM for the process.
    
    Parameters:
    
    arguments - The arguments. Must not be null.
    
    Returns:
    
    this
  - jvmArgs
```
NativeImageOptions jvmArgs(java.lang.Object... arguments)
```
    Adds some arguments to use to launch the JVM for the process.
    
    Parameters:
    
    arguments - The arguments.
    
    Returns:
    
    this
  - verbose
```
NativeImageOptions verbose(boolean verbose)
```
    Sets the native image build to be verbose
    
    Returns:
    
    this
  - enableServerBuild
```
NativeImageOptions enableServerBuild(boolean enabled)
```
    Enables server build. Server build is disabled by default
    
    Returns:
    
    this
  - debug
```
NativeImageOptions debug(boolean debug)
```
    Builds a native image with debug symbols
    
    Returns:
    
    this
  - fallback
```
NativeImageOptions fallback(boolean fallback)
```
    Sets whether to enable a fallback or not
    
    Returns:
    
    this
  - isDebug
```
@Input
org.gradle.api.provider.Property<java.lang.Boolean> isDebug()
```
    Returns:
    
    Is debug enabled
  - isVerbose
```
@Input
org.gradle.api.provider.Property<java.lang.Boolean> isVerbose()
```
    Returns:
    
    Is verbose output
  - isServerBuild
```
@Input
org.gradle.api.provider.Property<java.lang.Boolean> isServerBuild()
```
    Returns:
    
    Should the build run on a server (defaults to false).

Interface NativeImageOptions

Method Summary

Method Detail

isFallback

getImageName

setImageName

getMain

setMain

args

args

setArgs

setArgs

getSystemProperties

setSystemProperties

systemProperties

systemProperty

classpath

getClasspath

setClasspath

getJvmArgs

setJvmArgs

setJvmArgs

jvmArgs

jvmArgs

verbose

enableServerBuild

debug

fallback

isDebug

isVerbose

isServerBuild