ArchiveHandler (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, OptionHandler

All Known Implementing Classes:

AbstractArchiveHandler, TarArchiveHandler, ZipArchiveHandler
```
public interface ArchiveHandler
extends OptionHandler
```
Interface of archive handlers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`archiveTipText()`	Returns the tip text for this property.
`boolean`	`extract(String archiveFile, File outFile)`	Extracts the specified file and saves it locally.
`PlaceholderFile`	`getArchive()`	Returns the current archive.
`String[]`	`getExtensions()`	Returns the list of extensions (without dot) that this handler can take care of.
`String[]`	`getFiles()`	Returns the files stored in the archive.
`void`	`setArchive(PlaceholderFile value)`	Sets the archive to get the files from.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Method Detail
  - getExtensions
```
String[] getExtensions()
```
    Returns the list of extensions (without dot) that this handler can take care of.
    
    Returns:
    
    the list of extensions (no dot)
  - setArchive
```
void setArchive(PlaceholderFile value)
```
    Sets the archive to get the files from.
    
    Parameters:
    
    value - the archive
  - getArchive
```
PlaceholderFile getArchive()
```
    Returns the current archive.
    
    Returns:
    
    the archive
  - archiveTipText
```
String archiveTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getFiles
```
String[] getFiles()
```
    Returns the files stored in the archive.
    
    Returns:
    
    the files
    
    See Also:
    
    extract(String, File)
  - extract
```
boolean extract(String archiveFile,
                File outFile)
```
    Extracts the specified file and saves it locally.
    
    Parameters:
    
    archiveFile - the file in the archive to extract
    
    outFile - the local file to store the content in
    
    Returns:
    
    true if successfully extracted