java.lang.Object
- tv.hd3g.fflauncher.ConversionTool

All Implemented Interfaces:: tv.hd3g.processlauncher.tool.ExecutableTool

Direct Known Subclasses:: FFbase

public class ConversionTool
extends Object
implements tv.hd3g.processlauncher.tool.ExecutableTool

Field Summary

Fields
Modifier and Type	Field	Description
`static BiConsumer<tv.hd3g.processlauncher.cmdline.Parameters,String>`	`APPEND_PARAM_AT_END`
`protected String`	`execName`
`protected List<tv.hd3g.fflauncher.ConversionToolParameterReference>`	`inputSources`
`protected List<tv.hd3g.fflauncher.ConversionToolParameterReference>`	`outputExpectedDestinations`
`protected tv.hd3g.processlauncher.cmdline.Parameters`	`parameters`
`static BiConsumer<tv.hd3g.processlauncher.cmdline.Parameters,String>`	`PREPEND_PARAM_AT_START`

Constructor Summary

Constructors
Modifier	Constructor	Description
	`ConversionTool(String execName)`
`protected`	`ConversionTool(String execName, tv.hd3g.processlauncher.cmdline.Parameters parameters)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ConversionTool`	`addInputSource(File source, String varNameInParameters, String... parametersBeforeInputSource)`	Add a parameters via an input reference, like: [parametersBeforeInputSource] {varNameInParameters replaced by source} For example, set source = "/myfile", varNameInParameters = "IN", parametersBeforeInputSource = [-i], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE -i /myfile -send <%OUT%>"
`ConversionTool`	`addInputSource(File source, String varNameInParameters, Collection<String> parametersBeforeInputSource)`	Add a parameters via an input reference, like: [parametersBeforeInputSource] {varNameInParameters replaced by source} [parametersAfterInputSource] For example, set source = "/myfile", varNameInParameters = "IN", parametersBeforeInputSource = [-i], parametersAfterInputSource = [-w], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE -i /myfile -w -send <%OUT%>"
`ConversionTool`	`addInputSource(String source, String varNameInParameters, String... parametersBeforeInputSource)`	Add a parameters via an input reference, like: [parametersBeforeInputSource] {varNameInParameters replaced by source} For example, set source = "myfile", varNameInParameters = "IN", parametersBeforeInputSource = [-i], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE -i myfile -send <%OUT%>"
`ConversionTool`	`addInputSource(String source, String varNameInParameters, Collection<String> parametersBeforeInputSource)`	Add a parameters via an input reference, like: [parametersBeforeInputSource] {varNameInParameters replaced by source} [parametersAfterInputSource] For example, set source = "myfile", varNameInParameters = "IN", parametersBeforeInputSource = [-i], parametersAfterInputSource = [-w], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE -i myfile -w -send <%OUT%>"
`ConversionTool`	`addOutputDestination(File destination, String varNameInParameters, String... parametersBeforeOutputDestination)`	Add a parameters via an output reference, like: [parametersBeforeOutputDestination] {varNameInParameters replaced by destination} For example, set destination = "myfile", varNameInParameters = "OUT", parametersBeforeOutputDestination = [-o], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE <%IN%> -send -o myfile"
`ConversionTool`	`addOutputDestination(File destination, String varNameInParameters, Collection<String> parametersBeforeOutputDestination)`	Add a parameters via an output reference, like: [parametersBeforeOutputDestination] {varNameInParameters replaced by destination} [parametersAfterOutputDestination] For example, set destination = "myfile", varNameInParameters = "OUT", parametersBeforeOutputDestination = [-o], parametersAfterOutputDestination = [-w], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE <%IN%> -send -o myfile -w"
`ConversionTool`	`addOutputDestination(String destination, String varNameInParameters, String... parametersBeforeOutputDestination)`	Add a parameters via an output reference, like: [parametersBeforeOutputDestination] {varNameInParameters replaced by destination} For example, set destination = "myfile", varNameInParameters = "OUT", parametersBeforeOutputDestination = [-o], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE <%IN%> -send -o myfile"
`ConversionTool`	`addOutputDestination(String destination, String varNameInParameters, Collection<String> parametersBeforeOutputDestination)`	Add a parameters via an output reference, like: [parametersBeforeOutputDestination] {varNameInParameters replaced by destination} [parametersAfterOutputDestination] For example, set destination = "myfile", varNameInParameters = "OUT", parametersBeforeOutputDestination = [-o], parametersAfterOutputDestination = [-w], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE <%IN%> -send -o myfile -w"
`ConversionTool`	`addSimpleOutputDestination(File destinationFile)`	Define cmd var name like <%OUT_AUTOMATIC_n%> with "n" the # of setted destination.
`ConversionTool`	`addSimpleOutputDestination(String destinationName)`	Define cmd var name like <%OUT_AUTOMATIC_n%> with "n" the # of setted destination.
`void`	`beforeRun(tv.hd3g.processlauncher.ProcesslauncherBuilder processBuilder)`
`ConversionTool`	`checkDestinations()`	Check read access for every files set in output.
`ConversionTool`	`checkSources()`	Check read access for every files set in input.
`ConversionTool`	`cleanUpOutputFiles(boolean remove_all, boolean clean_output_directories)`	Don't need to be executed before.
`void`	`fixIOParametredVars(BiConsumer<tv.hd3g.processlauncher.cmdline.Parameters,String> onMissingInputVar, BiConsumer<tv.hd3g.processlauncher.cmdline.Parameters,String> onMissingOutputVar)`	Search and patch missing I/O parameter vars, and manageCollisionsParameters for each I/O entries.
`Optional<String>`	`getDeclaredDestinationByVarName(String var_name)`
`List<String>`	`getDeclaredDestinations()`
`Optional<String>`	`getDeclaredSourceByVarName(String var_name)`
`List<String>`	`getDeclaredSources()`
`String`	`getExecutableName()`
`Optional<Predicate<tv.hd3g.processlauncher.LineEntry>>`	`getFilterForLinesEventsToDisplay()`
`tv.hd3g.processlauncher.cmdline.Parameters`	`getInternalParameters()`
`long`	`getMaxExecTime(TimeUnit unit)`
`ScheduledExecutorService`	`getMaxExecTimeScheduler()`
`List<File>`	`getOutputFiles(OutputFilePresencePolicy filterPolicy)`	Don't need to be executed before, only checks.
`Map<String,String>`	`getParametersVariables()`	Set values for variables like <%myvar%> in the command line, do NOT set input/output references if they was set with addInputSource/addOutputDestination.
`tv.hd3g.processlauncher.cmdline.Parameters`	`getReadyToRunParameters()`
`protected PrintStream`	`getStdErrPrintStreamToDisplayLinesEvents()`
`protected PrintStream`	`getStdOutPrintStreamToDisplayLinesEvents()`
`File`	`getWorkingDirectory()`
`boolean`	`isCheckSourcesBeforeReady()`
`boolean`	`isOnErrorDeleteOutFiles()`
`boolean`	`isRemoveParamsIfNoVarToInject()`
`protected void`	`onMissingInputOutputVar(String var_name, String ressource)`
`protected String`	`patchVarName(String rawVarName)`
`ConversionTool`	`setCheckSourcesBeforeReady(boolean checkSourcesBeforeReady)`	True by default.
`ConversionTool`	`setFilterForLinesEventsToDisplay(Predicate<tv.hd3g.processlauncher.LineEntry> filterForLinesEventsToDisplay)`
`ConversionTool`	`setMaxExecTimeScheduler(ScheduledExecutorService maxExecTimeScheduler)`	Enable the execution time limitation
`ConversionTool`	`setMaxExecutionTimeForShortCommands(long max_exec_time, TimeUnit unit)`	You needs to provide a maxExecTimeScheduler
`ConversionTool`	`setOnErrorDeleteOutFiles(boolean onErrorDeleteOutFiles)`
`ConversionTool`	`setRemoveParamsIfNoVarToInject(boolean remove_params_if_no_var_to_inject)`
`ConversionTool`	`setWorkingDirectory(File workingDirectory)`

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

Methods inherited from interface tv.hd3g.processlauncher.tool.ExecutableTool
filterOutErrorLines

- Field Detail
  - execName
```
protected final String execName
```
  - inputSources
```
protected final List<tv.hd3g.fflauncher.ConversionToolParameterReference> inputSources
```
  - outputExpectedDestinations
```
protected final List<tv.hd3g.fflauncher.ConversionToolParameterReference> outputExpectedDestinations
```
  - parameters
```
protected final tv.hd3g.processlauncher.cmdline.Parameters parameters
```
  - APPEND_PARAM_AT_END
```
public static final BiConsumer<tv.hd3g.processlauncher.cmdline.Parameters,String> APPEND_PARAM_AT_END
```
  - PREPEND_PARAM_AT_START
```
public static final BiConsumer<tv.hd3g.processlauncher.cmdline.Parameters,String> PREPEND_PARAM_AT_START
```
- Constructor Detail
  - ConversionTool
```
public ConversionTool(String execName)
```
  - ConversionTool
```
protected ConversionTool(String execName,
                         tv.hd3g.processlauncher.cmdline.Parameters parameters)
```
- Method Detail
  - isRemoveParamsIfNoVarToInject
```
public boolean isRemoveParamsIfNoVarToInject()
```
  - setRemoveParamsIfNoVarToInject
```
public ConversionTool setRemoveParamsIfNoVarToInject(boolean remove_params_if_no_var_to_inject)
```
  - setMaxExecutionTimeForShortCommands
```
public ConversionTool setMaxExecutionTimeForShortCommands(long max_exec_time,
                                                          TimeUnit unit)
```
    You needs to provide a maxExecTimeScheduler
  - setMaxExecTimeScheduler
```
public ConversionTool setMaxExecTimeScheduler(ScheduledExecutorService maxExecTimeScheduler)
```
    Enable the execution time limitation
  - getMaxExecTime
```
public long getMaxExecTime(TimeUnit unit)
```
  - getMaxExecTimeScheduler
```
public ScheduledExecutorService getMaxExecTimeScheduler()
```
  - setFilterForLinesEventsToDisplay
```
public ConversionTool setFilterForLinesEventsToDisplay(Predicate<tv.hd3g.processlauncher.LineEntry> filterForLinesEventsToDisplay)
```
  - getFilterForLinesEventsToDisplay
```
public Optional<Predicate<tv.hd3g.processlauncher.LineEntry>> getFilterForLinesEventsToDisplay()
```
  - getParametersVariables
```
public Map<String,String> getParametersVariables()
```
    Set values for variables like <%myvar%> in the command line, do NOT set input/output references if they was set with addInputSource/addOutputDestination.
  - addInputSource
```
public ConversionTool addInputSource(String source,
                                     String varNameInParameters,
                                     String... parametersBeforeInputSource)
```
    Add a parameters via an input reference, like: [parametersBeforeInputSource] {varNameInParameters replaced by source} For example, set source = "myfile", varNameInParameters = "IN", parametersBeforeInputSource = [-i], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE -i myfile -send <%OUT%>"
    
    Parameters:
    
    source - can be another var name (mindfuck)
  - addInputSource
```
public ConversionTool addInputSource(File source,
                                     String varNameInParameters,
                                     String... parametersBeforeInputSource)
```
    Add a parameters via an input reference, like: [parametersBeforeInputSource] {varNameInParameters replaced by source} For example, set source = "/myfile", varNameInParameters = "IN", parametersBeforeInputSource = [-i], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE -i /myfile -send <%OUT%>"
  - addInputSource
```
public ConversionTool addInputSource(String source,
                                     String varNameInParameters,
                                     Collection<String> parametersBeforeInputSource)
```
    Add a parameters via an input reference, like: [parametersBeforeInputSource] {varNameInParameters replaced by source} [parametersAfterInputSource] For example, set source = "myfile", varNameInParameters = "IN", parametersBeforeInputSource = [-i], parametersAfterInputSource = [-w], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE -i myfile -w -send <%OUT%>"
    
    Parameters:
    
    source - can be another var name (mindfuck)
    
    parametersBeforeInputSource - can be null, and can be another var name (mindfuck)
    
    parametersAfterInputSource - can be null, and can be another var name (mindfuck)
  - patchVarName
```
protected String patchVarName(String rawVarName)
```
  - addInputSource
```
public ConversionTool addInputSource(File source,
                                     String varNameInParameters,
                                     Collection<String> parametersBeforeInputSource)
```
    Add a parameters via an input reference, like: [parametersBeforeInputSource] {varNameInParameters replaced by source} [parametersAfterInputSource] For example, set source = "/myfile", varNameInParameters = "IN", parametersBeforeInputSource = [-i], parametersAfterInputSource = [-w], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE -i /myfile -w -send <%OUT%>"
    
    Parameters:
    
    parametersBeforeInputSource - can be null, and can be another var name (mindfuck)
    
    parametersAfterInputSource - can be null, and can be another var name (mindfuck)
  - addOutputDestination
```
public ConversionTool addOutputDestination(String destination,
                                           String varNameInParameters,
                                           String... parametersBeforeOutputDestination)
```
    Add a parameters via an output reference, like: [parametersBeforeOutputDestination] {varNameInParameters replaced by destination} For example, set destination = "myfile", varNameInParameters = "OUT", parametersBeforeOutputDestination = [-o], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE <%IN%> -send -o myfile"
    
    Parameters:
    
    destination - can be another var name (mindfuck)
  - addOutputDestination
```
public ConversionTool addOutputDestination(File destination,
                                           String varNameInParameters,
                                           String... parametersBeforeOutputDestination)
```
    Add a parameters via an output reference, like: [parametersBeforeOutputDestination] {varNameInParameters replaced by destination} For example, set destination = "myfile", varNameInParameters = "OUT", parametersBeforeOutputDestination = [-o], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE <%IN%> -send -o myfile"
  - addOutputDestination
```
public ConversionTool addOutputDestination(String destination,
                                           String varNameInParameters,
                                           Collection<String> parametersBeforeOutputDestination)
```
    Add a parameters via an output reference, like: [parametersBeforeOutputDestination] {varNameInParameters replaced by destination} [parametersAfterOutputDestination] For example, set destination = "myfile", varNameInParameters = "OUT", parametersBeforeOutputDestination = [-o], parametersAfterOutputDestination = [-w], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE <%IN%> -send -o myfile -w"
    
    Parameters:
    
    destination - can be another var name (mindfuck)
    
    parametersBeforeOutputDestination - can be null, and can be another var name (mindfuck)
    
    parametersAfterOutputDestination - can be null, and can be another var name (mindfuck)
  - addOutputDestination
```
public ConversionTool addOutputDestination(File destination,
                                           String varNameInParameters,
                                           Collection<String> parametersBeforeOutputDestination)
```
    Add a parameters via an output reference, like: [parametersBeforeOutputDestination] {varNameInParameters replaced by destination} [parametersAfterOutputDestination] For example, set destination = "myfile", varNameInParameters = "OUT", parametersBeforeOutputDestination = [-o], parametersAfterOutputDestination = [-w], For an parameters = "exec -VERBOSE <%IN%> -send <%OUT%>", you will get an updated parameters: "exec -VERBOSE <%IN%> -send -o myfile -w"
    
    Parameters:
    
    parametersBeforeOutputDestination - can be null, and can be another var name (mindfuck)
    
    parametersAfterOutputDestination - can be null, and can be another var name (mindfuck)
  - onMissingInputOutputVar
```
protected void onMissingInputOutputVar(String var_name,
                                       String ressource)
```
  - getWorkingDirectory
```
public File getWorkingDirectory()
```
    Returns:
    
    Can be null.
  - setWorkingDirectory
```
public ConversionTool setWorkingDirectory(File workingDirectory)
                                   throws IOException
```
    Throws:
    
    IOException
  - isOnErrorDeleteOutFiles
```
public boolean isOnErrorDeleteOutFiles()
```
  - setOnErrorDeleteOutFiles
```
public ConversionTool setOnErrorDeleteOutFiles(boolean onErrorDeleteOutFiles)
```
  - beforeRun
```
public void beforeRun(tv.hd3g.processlauncher.ProcesslauncherBuilder processBuilder)
```
    Specified by:
    
    beforeRun in interface tv.hd3g.processlauncher.tool.ExecutableTool
  - getStdOutPrintStreamToDisplayLinesEvents
```
protected PrintStream getStdOutPrintStreamToDisplayLinesEvents()
```
  - getStdErrPrintStreamToDisplayLinesEvents
```
protected PrintStream getStdErrPrintStreamToDisplayLinesEvents()
```
  - getDeclaredSourceByVarName
```
public Optional<String> getDeclaredSourceByVarName(String var_name)
```
    Parameters:
    
    varName - with tags
    
    Returns:
    
    never null
  - getDeclaredDestinationByVarName
```
public Optional<String> getDeclaredDestinationByVarName(String var_name)
```
    Parameters:
    
    varName - with tags
    
    Returns:
    
    never null
  - getDeclaredSources
```
public List<String> getDeclaredSources()
```
    Returns:
    
    never null, can be empty
  - getDeclaredDestinations
```
public List<String> getDeclaredDestinations()
```
    Returns:
    
    never null, can be empty
  - addSimpleOutputDestination
```
public ConversionTool addSimpleOutputDestination(String destinationName)
```
    Define cmd var name like <%OUT_AUTOMATIC_n%> with "n" the # of setted destination. Don't forget to call fixIOParametredVars() for add the new created var in current Parameters.
  - addSimpleOutputDestination
```
public ConversionTool addSimpleOutputDestination(File destinationFile)
```
    Define cmd var name like <%OUT_AUTOMATIC_n%> with "n" the # of setted destination. Don't forget to call fixIOParametredVars() for add the new created var in current Parameters.
  - getOutputFiles
```
public List<File> getOutputFiles(OutputFilePresencePolicy filterPolicy)
```
    Don't need to be executed before, only checks.
  - cleanUpOutputFiles
```
public ConversionTool cleanUpOutputFiles(boolean remove_all,
                                         boolean clean_output_directories)
```
    Don't need to be executed before.
    
    Parameters:
    
    remove_all - if false, remove only empty files.
  - getInternalParameters
```
public tv.hd3g.processlauncher.cmdline.Parameters getInternalParameters()
```
    Returns:
    
    without variable injection
  - setCheckSourcesBeforeReady
```
public ConversionTool setCheckSourcesBeforeReady(boolean checkSourcesBeforeReady)
```
    True by default. Force to check read access for every files set in input.
    
    Returns:
    
    this
  - isCheckSourcesBeforeReady
```
public boolean isCheckSourcesBeforeReady()
```
    Returns:
    
    true by default. Force to check read access for every files set in input.
  - checkSources
```
public ConversionTool checkSources()
```
    Check read access for every files set in input.
    
    Throws:
    
    RuntimeException
  - checkDestinations
```
public ConversionTool checkDestinations()
```
    Check read access for every files set in output.
    
    Throws:
    
    RuntimeException
  - fixIOParametredVars
```
public void fixIOParametredVars(BiConsumer<tv.hd3g.processlauncher.cmdline.Parameters,String> onMissingInputVar,
                                BiConsumer<tv.hd3g.processlauncher.cmdline.Parameters,String> onMissingOutputVar)
```
    Search and patch missing I/O parameter vars, and manageCollisionsParameters for each I/O entries.
    
    Parameters:
    
    onMissingInputVar - you can manually add the var (the String value provided) in the provided Parameters
    
    onMissingOutputVar - you can manually add the var (the String value provided) in the provided Parameters
  - getReadyToRunParameters
```
public tv.hd3g.processlauncher.cmdline.Parameters getReadyToRunParameters()
```
    Specified by:
    
    getReadyToRunParameters in interface tv.hd3g.processlauncher.tool.ExecutableTool
    
    Returns:
    
    a copy form internal parameters, with variable injection
  - getExecutableName
```
public String getExecutableName()
```
    Specified by:
    
    getExecutableName in interface tv.hd3g.processlauncher.tool.ExecutableTool

Class ConversionTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface tv.hd3g.processlauncher.tool.ExecutableTool

Field Detail

execName

inputSources

outputExpectedDestinations

parameters

APPEND_PARAM_AT_END

PREPEND_PARAM_AT_START

Constructor Detail

ConversionTool

ConversionTool

Method Detail

isRemoveParamsIfNoVarToInject

setRemoveParamsIfNoVarToInject

setMaxExecutionTimeForShortCommands

setMaxExecTimeScheduler

getMaxExecTime

getMaxExecTimeScheduler

setFilterForLinesEventsToDisplay

getFilterForLinesEventsToDisplay

getParametersVariables

addInputSource

addInputSource

addInputSource

patchVarName

addInputSource

addOutputDestination

addOutputDestination

addOutputDestination

addOutputDestination

onMissingInputOutputVar

getWorkingDirectory

setWorkingDirectory

isOnErrorDeleteOutFiles

setOnErrorDeleteOutFiles

beforeRun

getStdOutPrintStreamToDisplayLinesEvents

getStdErrPrintStreamToDisplayLinesEvents

getDeclaredSourceByVarName

getDeclaredDestinationByVarName

getDeclaredSources

getDeclaredDestinations

addSimpleOutputDestination

addSimpleOutputDestination

getOutputFiles

cleanUpOutputFiles

getInternalParameters

setCheckSourcesBeforeReady

isCheckSourcesBeforeReady

checkSources

checkDestinations

fixIOParametredVars

getReadyToRunParameters

getExecutableName