ChocoExecutor.ChocoExecutorBuilder (simple-choco 1.1.0 API)

java.lang.Object
- xyz.ronella.gradle.plugin.simple.choco.ChocoExecutor.ChocoExecutorBuilder

Enclosing class:

ChocoExecutor
```
public static class ChocoExecutor.ChocoExecutorBuilder
extends java.lang.Object
```
The only class that can create a ChocoExecutor instance.

Since:

v1.0.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChocoExecutor.ChocoExecutorBuilder`	`addAdminMode(boolean isAdminMode)` Adds an indication assembled choco command will be executed in admin mode.
`ChocoExecutor.ChocoExecutorBuilder`	`addArgs(java.lang.String... args)` Adds multiple arguments in one command.
`ChocoExecutor.ChocoExecutorBuilder`	`addAutoInstall(boolean isAutoInstall)` Adds an indication if the ChocoExecutor will auto install chocolatey.
`ChocoExecutor.ChocoExecutorBuilder`	`addChocoHome(java.io.File chocoHome)` Adds the location of a non-standard location of chocolatey installation.
`ChocoExecutor.ChocoExecutorBuilder`	`addCommand(java.lang.String command)` Add the choco command the be executed.
`ChocoExecutor.ChocoExecutorBuilder`	`addForceAdminMode(boolean forceAdminMode)` Adds an indication that the choco is being force to run in admin mode.
`ChocoExecutor.ChocoExecutorBuilder`	`addLogging(boolean hasLogging)` Adds an indication that the choco must log its activities to a file.
`ChocoExecutor.ChocoExecutorBuilder`	`addNoop(boolean noop)` Adds an indication that no actual choco command will be executed
`ChocoExecutor.ChocoExecutorBuilder`	`addNoScriptDeletion(boolean noScriptDeletion)` Indicates that the script generated will not be deleted.
`ChocoExecutor.ChocoExecutorBuilder`	`addOSType(OSType osType)` Add an OSType in the builder.
`ChocoExecutor.ChocoExecutorBuilder`	`addPackages(java.util.List<java.util.List<java.lang.String>> packages)` The the packages to be scripted.
`ChocoExecutor.ChocoExecutorBuilder`	`addRunningOnAdmin(boolean runningOnAdmin)` Adds an indication that the choco is already running on administration mode.
`ChocoExecutor.ChocoExecutorBuilder`	`addScriptMode(boolean scriptMode)` Adds an indication that the choco commands will be scripted.
`ChocoExecutor.ChocoExecutorBuilder`	`addTaskName(java.lang.String taskName)` Adds the name of the task being executed.
`ChocoExecutor.ChocoExecutorBuilder`	`addZArgs(java.lang.String... args)` Adds multiple zArguments in one command.
`ChocoExecutor`	`build()` The method that actually builds an instance of ChocoExecutor.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addOSType
```
public ChocoExecutor.ChocoExecutorBuilder addOSType(OSType osType)
```
    Add an OSType in the builder.
    
    Parameters:
    
    osType - An instance of the OSType enum.
    
    Returns:
    
    An instance of the builder.
  - addAutoInstall
```
public ChocoExecutor.ChocoExecutorBuilder addAutoInstall(boolean isAutoInstall)
```
    Adds an indication if the ChocoExecutor will auto install chocolatey.
    
    Parameters:
    
    isAutoInstall - Set to true to indicate auto installation.
    
    Returns:
    
    An instance of the builder.
  - addChocoHome
```
public ChocoExecutor.ChocoExecutorBuilder addChocoHome(java.io.File chocoHome)
```
    Adds the location of a non-standard location of chocolatey installation.
    
    Parameters:
    
    chocoHome - An instance of File holding the location of chocolatey.
    
    Returns:
    
    An instance of the builder.
  - addCommand
```
public ChocoExecutor.ChocoExecutorBuilder addCommand(java.lang.String command)
```
    Add the choco command the be executed.
    
    Parameters:
    
    command - The command to be executed.
    
    Returns:
    
    An instance of the builder.
  - addArgs
```
public ChocoExecutor.ChocoExecutorBuilder addArgs(java.lang.String... args)
```
    Adds multiple arguments in one command.
    
    Parameters:
    
    args - An array of arguments.
    
    Returns:
    
    An instance of the builder.
  - addZArgs
```
public ChocoExecutor.ChocoExecutorBuilder addZArgs(java.lang.String... args)
```
    Adds multiple zArguments in one command.
    
    Parameters:
    
    args - An array of arguments.
    
    Returns:
    
    An instance of the builder.
  - addNoop
```
public ChocoExecutor.ChocoExecutorBuilder addNoop(boolean noop)
```
    Adds an indication that no actual choco command will be executed
    
    Parameters:
    
    noop - Set to true to stop prevent execution.
    
    Returns:
    
    An instance of the builder.
  - addAdminMode
```
public ChocoExecutor.ChocoExecutorBuilder addAdminMode(boolean isAdminMode)
```
    Adds an indication assembled choco command will be executed in admin mode.
    
    Parameters:
    
    isAdminMode - Set to true to run the command in admin mode.
    
    Returns:
    
    An instance of the builder.
  - addLogging
```
public ChocoExecutor.ChocoExecutorBuilder addLogging(boolean hasLogging)
```
    Adds an indication that the choco must log its activities to a file.
    
    Parameters:
    
    hasLogging - Set to true to enable choco logging.
    
    Returns:
    
    An instance of the builder.
  - addRunningOnAdmin
```
public ChocoExecutor.ChocoExecutorBuilder addRunningOnAdmin(boolean runningOnAdmin)
```
    Adds an indication that the choco is already running on administration mode.
    
    Parameters:
    
    runningOnAdmin - True if running on administration mode.
    
    Returns:
    
    An instance of the builder.
    
    Since:
    
    1.1.0
  - addForceAdminMode
```
public ChocoExecutor.ChocoExecutorBuilder addForceAdminMode(boolean forceAdminMode)
```
    Adds an indication that the choco is being force to run in admin mode.
    
    Parameters:
    
    forceAdminMode - True if running on to force administration mode.
    
    Returns:
    
    An instance of the builder.
    
    Since:
    
    1.1.0
  - addScriptMode
```
public ChocoExecutor.ChocoExecutorBuilder addScriptMode(boolean scriptMode)
```
    Adds an indication that the choco commands will be scripted.
    
    Parameters:
    
    scriptMode - True the commands will be scripted.
    
    Returns:
    
    An instance of the builder.
    
    Since:
    
    1.1.0
  - addTaskName
```
public ChocoExecutor.ChocoExecutorBuilder addTaskName(java.lang.String taskName)
```
    Adds the name of the task being executed.
    
    Parameters:
    
    taskName - The name of the task.
    
    Returns:
    
    An instance of the builder.
    
    Since:
    
    1.1.0
  - addPackages
```
public ChocoExecutor.ChocoExecutorBuilder addPackages(java.util.List<java.util.List<java.lang.String>> packages)
```
    The the packages to be scripted.
    
    Parameters:
    
    packages - The name of the task.
    
    Returns:
    
    An instance of the builder.
    
    Since:
    
    1.1.0
  - addNoScriptDeletion
```
public ChocoExecutor.ChocoExecutorBuilder addNoScriptDeletion(boolean noScriptDeletion)
```
    Indicates that the script generated will not be deleted.
    
    Parameters:
    
    noScriptDeletion - The name of the task.
    
    Returns:
    
    An instance of the builder.
    
    Since:
    
    1.1.0
  - build
```
public ChocoExecutor build()
```
    The method that actually builds an instance of ChocoExecutor.
    
    Returns:
    
    An instance of the ChocoExecutor.

Class ChocoExecutor.ChocoExecutorBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addOSType

addAutoInstall

addChocoHome

addCommand

addArgs

addZArgs

addNoop

addAdminMode

addLogging

addRunningOnAdmin

addForceAdminMode

addScriptMode

addTaskName

addPackages

addNoScriptDeletion

build