Package adams.flow.transformer

Class UnTar

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class UnTar
extends AbstractMultiDecompress
    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).

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       java.lang.String[]


    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: UnTar
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -out-dir <adams.core.io.PlaceholderDirectory> (property: outputDir)
    The output directory to use.
    default: ${CWD}
 
    -reg-exp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression that the file names must match in order to be extracted.
    default: .*
 
    -invert (property: invertMatching)
    If set to true, the matching sense of the regular expression is inverted.
 
    -create-dirs (property: createDirectories)
    If set to true, the directory structure stored in the archive will be restored.
 
    -buffer <int> (property: bufferSize)
    The size of the buffer in bytes for the data stream.
    default: 1024
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form