Name

adams.flow.transformer.UnTar

Synopsis

Decompresses a Tar archive and broadcasts the full file names of the extracted files. A regular expression can be used to control the files that are being extracted. Whether the directory structure in the Tar archive gets restored is optional. The compression that the archive uses (gzip or bzip2) is automatically determined based on the extension (.gz or .bz2).

Additional information

Flow input/output:
- input: java.lang.String, java.io.File
- output: java.lang.String[]

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	UnTar

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• outputDir
  

  The output directory to use.

  command-line	-out-dir <adams.core.io.PlaceholderDirectory>
  default	${CWD}

  
  
• regExp
  

  The regular expression that the file names must match in order to be extracted.

  command-line	-reg-exp <adams.core.base.BaseRegExp>
  default	.*
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html

  
  
• invertMatching
  

  If set to true, the matching sense of the regular expression is inverted.

  command-line	-invert <boolean>
  default	false

  
  
• createDirectories
  

  If set to true, the directory structure stored in the archive will be restored.

  command-line	-create-dirs <boolean>
  default	false

  
  
• bufferSize
  

  The size of the buffer in bytes for the data stream.

  command-line	-buffer <int>
  default	1024
  minimum	1