TarArchive Members

Public Static (Shared) Methods

CreateInputTarArchiveOverloaded. The InputStream based constructors create a TarArchive for the purposes of e'x'tracting or lis't'ing a tar archive. Thus, use these constructors when you wish to extract files from or list the contents of an existing tar archive.
CreateOutputTarArchiveOverloaded. The OutputStream based constructors create a TarArchive for the purposes of 'c'reating a tar archive. Thus, use these constructors when you wish to create a new tar archive and write files into it.

Public Instance Properties

GroupId Get the group id being used for archive entry headers.
GroupName Get the group name being used for archive entry headers.
IsVerbose Get/Set the verbosity setting.
RecordSize Get the archive's record size. Because of its history, tar supports the concept of buffered IO consisting of BLOCKS of RECORDS. This allowed tar to match the IO characteristics of the physical device being used. Of course, in the Java world, this makes no sense, WITH ONE EXCEPTION - archives are expected to be propertly "blocked". Thus, all of the horrible TarBuffer support boils down to simply getting the "boundaries" correct.
UserId Get the user id being used for archive entry headers.
UserName Get the user name being used for archive entry headers.

Public Instance Methods

CloseArchive Close the archive. This simply calls the underlying tar stream's close() method.
Equals (inherited from Object)Select the method name to go to the Microsoft documentation.
ExtractContents Perform the "extract" command and extract the contents of the archive.
GetHashCode (inherited from Object)Select the method name to go to the Microsoft documentation.
GetType (inherited from Object)Select the method name to go to the Microsoft documentation.
ListContents Perform the "list" command and list the contents of the archive. NOTE That this method uses the progress display to actually list the conents. If the progress display is not set, nothing will be listed!
SetAsciiTranslation Set the ascii file translation flag. If ascii file translatio is true, then the MIME file type will be consulted to determine if the file is of type 'text/*'. If the MIME type is not found, then the TransFileTyper is consulted if it is not null. If either of these two checks indicates the file is an ascii text file, it will be translated. The translation converts the local operating system's concept of line ends into the UNIX line end, '\n', which is the defacto standard for a TAR archive. This makes text files compatible with UNIX, and since most tar implementations text files compatible with UNIX, and since most tar implementations
SetDebug
SetKeepOldFiles Set the flag that determines whether existing files are kept, or overwritten during extraction.
SetUserInfo Set user and group information that will be used to fill in the tar archive's entry headers. Since Java currently provides no means of determining a user name, user id, group name, or group id for a given File, TarArchive allows the programmer to specify values to be used in their place.
ToString (inherited from Object)Select the method name to go to the Microsoft documentation.
WriteEntry Write an entry to the archive. This method will call the putNextEntry and then write the contents of the entry, and finally call closeEntry()() for entries that are files. For directories, it will call putNextEntry(), and then, if the recurse flag is true, process each entry that is a child of the directory.

Public Instance Events

ProgressMessageEvent

Protected Instance Constructors

TarArchive Constructor

Protected Instance Fields

asciiTranslate
debug
groupId
groupName
keepOldFiles
pathPrefix
recordBuf
recordSize
rootPath
tarIn
tarOut
userId
userName
verbose

Protected Instance Methods

Finalize (inherited from Object)Select the method name to go to the Microsoft documentation.
MemberwiseClone (inherited from Object)Select the method name to go to the Microsoft documentation.
OnProgressMessageEvent

See Also

TarArchive Class | ICSharpCode.SharpZipLib.Tar Namespace