@groovy.util.logging.Slf4j @groovy.transform.InheritConstructors class FileOutParam extends BaseOutParam
Model a process *file* output parameter
| Fields inherited from class | Fields |
|---|---|
class BaseOutParam |
intoObj, mode, nameObj, outChannels |
class BaseParam |
binding, holder |
| Type | Name and description |
|---|---|
boolean |
followLinksWhen true it follows symbolic links during directories tree traversal, otherwise they are managed as files (default: true) |
boolean |
glob |
boolean |
hiddenWhen true star wildcard (*) matches hidden files (files starting with a dot char)
By default it does not, coherently with linux bash rule |
boolean |
includeInputsWhen true file pattern includes input files as well as output files.
|
java.lang.Integer |
maxDepthMaximum number of directory levels to visit (default: no limit) |
boolean |
pathQualifier |
java.lang.String |
separatorCharThe character used to separate multiple names (pattern) in the output specification |
java.lang.String |
typeThe type of path to output, either file, dir or any |
| Constructor and description |
|---|
protected FileOutParam
(java.util.Map params)ONLY FOR TESTING DO NOT USE |
| Type Params | Return Type | Name and description |
|---|---|---|
|
BaseOutParam |
bind(java.lang.Object obj) |
|
FileOutParam |
followLinks(boolean value) |
|
java.util.List<java.lang.String> |
getFilePatterns(java.util.Map context, java.nio.file.Path workDir) |
|
java.lang.String |
getName()Override the default to allow null as a value name @return |
|
FileOutParam |
glob(boolean value) |
|
FileOutParam |
hidden(boolean flag) |
|
FileOutParam |
includeHidden(boolean flag) |
|
FileOutParam |
includeInputs(boolean flag) |
|
boolean |
isDynamic()@return true when the file name is parametric i.e contains a variable name to be resolved, false otherwise |
|
boolean |
isPathQualifier() |
|
FileOutParam |
maxDepth(int value) |
|
FileOutParam |
separatorChar(java.lang.String value) |
|
FileOutParam |
setOptions(java.util.Map<java.lang.String, ?> opts) |
|
FileOutParam |
setPathQualifier(boolean flag) |
|
FileOutParam |
type(java.lang.String value) |
| Methods inherited from class | Name |
|---|---|
class BaseOutParam |
bind, clone, getMode, getName, getOutChannel, getOutChannels, into, into, lazyInit, mode, outputValToChannel, setEmit, setInto, setOptions |
class BaseParam |
clone, getScriptVar, getScriptVar, getTypeSimpleName, init, isNestedParam, lazyInit, setOptions, toString |
When true it follows symbolic links during directories tree traversal, otherwise they are managed as files (default: true)
When true star wildcard (*) matches hidden files (files starting with a dot char)
By default it does not, coherently with linux bash rule
When true file pattern includes input files as well as output files.
By default a file pattern matches only against files produced by the process, not
the ones received as input
Maximum number of directory levels to visit (default: no limit)
The character used to separate multiple names (pattern) in the output specification This is only used by `file` qualifier. It's not supposed to be used anymore by the new `path` qualifier.
The type of path to output, either file, dir or any
Override the default to allow null as a value name
true when the file name is parametric i.e contains a variable name to be resolved, false otherwiseGroovy Documentation