gradle-plugin/io.spine.protodata.gradle.plugin/LaunchProtoData

LaunchProtoData

public abstract class LaunchProtoData extends JavaExec

A task which executes a single ProtoData command.

This class is public to allow users to find ProtoData tasks by their type. This is useful to configure task dependencies, enable and disable individual tasks, add conditions via onlyIf { }, etc.

Users should NOT change the CLI command, user directory, etc. directly. Please refer to the protoData { } extension configuring ProtoData.

Constructors

LaunchProtoData

public LaunchProtoData LaunchProtoData()

Inherited properties

conventionMapping

private final ConventionMapping conventionMapping

enabled

private Boolean enabled

hasCustomActions

private final Boolean hasCustomActions

impliesSubProjects

private Boolean impliesSubProjects

javaLauncher

private final Property<JavaLauncher> javaLauncher

mainClass

private final Property<String> mainClass

mainModule

private final Property<String> mainModule

modularity

private final ModularitySpec modularity

services

private final ServiceRegistry services

state

private final TaskStateInternal state

timeout

private final Property<Duration> timeout

Inherited functions

acceptServiceReferences

public Unit acceptServiceReferences(Set<ServiceReferenceSpec> serviceReferences)

appendParallelSafeAction

public Unit appendParallelSafeAction(Action<? super Task> action)

args

public JavaExec args(Object args)

public JavaExecSpec args(Iterable<?> args)

bootstrapClasspath

public JavaExec bootstrapClasspath(Object classpath)

classpath

public JavaExec classpath(Object paths)

compareTo

public Integer compareTo(Task other)

configure

public Task configure(Closure<Object> closure)

conventionMapping

public Task conventionMapping(String property, Closure<Object> mapping)

public Task conventionMapping(String property, Callable<?> mapping)

copyTo

public JavaExec copyTo(JavaForkOptions options)

public JavaExec copyTo(ProcessForkOptions target)

debugOptions

public Unit debugOptions(Action<JavaDebugOptions> action)

dependsOn

public Task dependsOn(Object paths)

doFirst

public Task doFirst(Closure<Object> action)

public Task doFirst(Action<? super Task> action)

public Task doFirst(String actionName, Action<? super Task> action)

doLast

public Task doLast(Closure<Object> action)

public Task doLast(Action<? super Task> action)

public Task doLast(String actionName, Action<? super Task> action)

doNotTrackState

public Unit doNotTrackState(String reasonNotToTrackState)

environment

public JavaExec environment(Map<String, ?> environmentVariables)

public JavaExec environment(String name, Object value)

exec

public Unit exec()

executable

public JavaExec executable(Object executable)

finalizedBy

public Task finalizedBy(Object paths)

getActions

public List<Action<? super Task>> getActions()

getAllJvmArgs

public List<String> getAllJvmArgs()

getAnt

public AntBuilder getAnt()

getArgs

public List<String> getArgs()

getArgumentProviders

public List<CommandLineArgumentProvider> getArgumentProviders()

getAsDynamicObject

@Internal()

public DynamicObject getAsDynamicObject()

getBootstrapClasspath

public FileCollection getBootstrapClasspath()

getClasspath

public FileCollection getClasspath()

getCommandLine

@Internal()

public List<String> getCommandLine()

getConvention

@Internal()

@Deprecated(message = "Deprecated in Java")

public Convention ~~getConvention~~()

getConventionMapping

@Internal()

public ConventionMapping getConventionMapping()

getDebug

public Boolean getDebug()

getDebugOptions

public JavaDebugOptions getDebugOptions()

getDefaultCharacterEncoding

public String getDefaultCharacterEncoding()

getDependsOn

public Set<Object> getDependsOn()

getDescription

public String getDescription()

getDestroyables

public TaskDestroyables getDestroyables()

getDidWork

public Boolean getDidWork()

getEnableAssertions

public Boolean getEnableAssertions()

getEnvironment

@Internal()

public Map<String, Object> getEnvironment()

getErrorOutput

@Internal()

public OutputStream getErrorOutput()

getExecActionFactory

@Inject()

protected ExecActionFactory getExecActionFactory()

getExecutable

@Internal(value = "covered by getJavaVersion")

@Nullable()

public String getExecutable()

getExecutionResult

@Internal()

public Provider<ExecResult> getExecutionResult()

getExtensions

public ExtensionContainer getExtensions()

getFinalizedBy

public TaskDependency getFinalizedBy()

getGroup

public String getGroup()

getIdentityPath

public Path getIdentityPath()

getImpliesSubProjects

public Boolean getImpliesSubProjects()

getInputs

public TaskInputsInternal getInputs()

getJavaLauncher

public Property<JavaLauncher> getJavaLauncher()

getJavaToolchainService

@Inject()

protected JavaToolchainService getJavaToolchainService()

getJavaVersion

@Input()

public JavaVersion getJavaVersion()

getJvmArgs

public List<String> getJvmArgs()

getJvmArgumentProviders

public List<CommandLineArgumentProvider> getJvmArgumentProviders()

getJvmArguments

public ListProperty<String> getJvmArguments()

getLifecycleDependencies

@Internal()

public TaskDependencyInternal getLifecycleDependencies()

getLocalState

public TaskLocalState getLocalState()

getLogger

public Logger getLogger()

getLogging

public LoggingManager getLogging()

getMainClass

public Property<String> getMainClass()

getMainModule

public Property<String> getMainModule()

getMaxHeapSize

public String getMaxHeapSize()

getMinHeapSize

public String getMinHeapSize()

getModularity

public ModularitySpec getModularity()

getMustRunAfter

public TaskDependency getMustRunAfter()

getName

public String getName()

getObjectFactory

@Inject()

protected ObjectFactory getObjectFactory()

getOnlyIf

public Spec<? super TaskInternal> getOnlyIf()

getOutputs

public TaskOutputsInternal getOutputs()

getPath

public String getPath()

getProject

public Project getProject()

getPropertyFactory

@Inject()

protected PropertyFactory getPropertyFactory()

getProviderFactory

@Inject()

protected ProviderFactory getProviderFactory()

getReasonNotToTrackState

public Optional<String> getReasonNotToTrackState()

getReasonTaskIsIncompatibleWithConfigurationCache

public Optional<String> getReasonTaskIsIncompatibleWithConfigurationCache()

getRequiredServices

public TaskRequiredServices getRequiredServices()

getServices

@Internal()

protected ServiceRegistry getServices()

getSharedResources

public List<ResourceLock> getSharedResources()

getShouldRunAfter

public TaskDependency getShouldRunAfter()

getStandardInput

@Internal()

public InputStream getStandardInput()

getStandardOutput

@Internal()

public OutputStream getStandardOutput()

getStandardOutputCapture

public StandardOutputCapture getStandardOutputCapture()

getState

public TaskStateInternal getState()

getSystemProperties

public Map<String, Object> getSystemProperties()

getTaskActions

public List<InputChangesAwareTaskAction> getTaskActions()

getTaskDependencies

public TaskDependencyInternal getTaskDependencies()

getTaskIdentity

public TaskIdentity<?> getTaskIdentity()

getTemporaryDir

public File getTemporaryDir()

getTemporaryDirFactory

public Factory<File> getTemporaryDirFactory()

getTimeout

public Property<Duration> getTimeout()

getWorkingDir

@Internal()

public File getWorkingDir()

hasProperty

public Boolean hasProperty(String propertyName)

hasTaskActions

public Boolean hasTaskActions()

isCompatibleWithConfigurationCache

public Boolean isCompatibleWithConfigurationCache()

isEnabled

@Internal()

public Boolean isEnabled()

isHasCustomActions

public Boolean isHasCustomActions()

isIgnoreExitValue

@Input()

public Boolean isIgnoreExitValue()

jvmArgs

public JavaExec jvmArgs(Object arguments)

public JavaExec jvmArgs(Iterable<?> arguments)

mustRunAfter

public Task mustRunAfter(Object paths)

notCompatibleWithConfigurationCache

public Unit notCompatibleWithConfigurationCache(String reason)

onlyIf

public Unit onlyIf(Closure<Object> onlyIfClosure)

public Unit onlyIf(Spec<? super Task> spec)

public Unit onlyIf(String onlyIfReason, Spec<? super Task> spec)

prependParallelSafeAction

public Unit prependParallelSafeAction(Action<? super Task> action)

property

public Object property(String propertyName)

setActions

public Unit setActions(List<Action<? super Task>> replacements)

setAllJvmArgs

public Unit setAllJvmArgs(Iterable<?> arguments)

public Unit setAllJvmArgs(List<String> arguments)

setArgs

public JavaExec setArgs(Iterable<?> applicationArgs)

public JavaExec setArgs(List<String> applicationArgs)

setArgsString

public JavaExec setArgsString(String args)

setBootstrapClasspath

public Unit setBootstrapClasspath(FileCollection classpath)

setClasspath

public JavaExec setClasspath(FileCollection classpath)

setDebug

public Unit setDebug(Boolean enabled)

setDefaultCharacterEncoding

public Unit setDefaultCharacterEncoding(String defaultCharacterEncoding)

setDependsOn

public Unit setDependsOn(Iterable<?> dependsOn)

setDescription

public Unit setDescription(String description)

setDidWork

public Unit setDidWork(Boolean didWork)

setEnableAssertions

public Unit setEnableAssertions(Boolean enabled)

setEnabled

public Unit setEnabled(Boolean enabled)

setEnvironment

public Unit setEnvironment(Map<String, ?> environmentVariables)

setErrorOutput

public JavaExec setErrorOutput(OutputStream outputStream)

setExecutable

public Unit setExecutable(Object executable)

public Unit setExecutable(String executable)

setFinalizedBy

public Unit setFinalizedBy(Iterable<?> finalizedByTasks)

setGroup

public Unit setGroup(String group)

setIgnoreExitValue

public JavaExecSpec setIgnoreExitValue(Boolean ignoreExitValue)

setImpliesSubProjects

public Unit setImpliesSubProjects(Boolean impliesSubProjects)

setJvmArgs

public Unit setJvmArgs(Iterable<?> arguments)

public Unit setJvmArgs(List<String> arguments)

setMain

@ReplacedBy(value = "mainClass")

@Deprecated(message = "Deprecated in Java")

public JavaExecSpec ~~setMain~~(@Nullable() String main)

setMaxHeapSize

public Unit setMaxHeapSize(String heapSize)

setMinHeapSize

public Unit setMinHeapSize(String heapSize)

setMustRunAfter

public Unit setMustRunAfter(Iterable<?> mustRunAfterTasks)

setOnlyIf

public Unit setOnlyIf(Closure<Object> onlyIfClosure)

public Unit setOnlyIf(Spec<? super Task> spec)

public Unit setOnlyIf(String onlyIfReason, Spec<? super Task> spec)

setProperty

public Unit setProperty(String name, Object value)

setShouldRunAfter

public Unit setShouldRunAfter(Iterable<?> shouldRunAfterTasks)

setStandardInput

public JavaExec setStandardInput(InputStream inputStream)

setStandardOutput

public JavaExec setStandardOutput(OutputStream outputStream)

setSystemProperties

public Unit setSystemProperties(Map<String, ?> properties)

setWorkingDir

public Unit setWorkingDir(File dir)

public Unit setWorkingDir(Object dir)

shouldRunAfter

public TaskDependency shouldRunAfter(Object paths)

systemProperties

public JavaExec systemProperties(Map<String, ?> properties)

systemProperty

public JavaExec systemProperty(String name, Object value)

usesService

public Unit usesService(Provider<? extends BuildService<?>> service)

workingDir

public JavaExec workingDir(Object dir)