de.schlichtherle.io.archive
Interface Archive

public interface Archive

Describes general properties of any archive. A single instance of this interface is created for every canonical path name representation of an archive file.

Client applications should never implement this interface because more features may be added in future.

Since:

TrueZIP 6.0

Version:

TrueZIP 6.7

Author:

Christian Schlichtherle

Method Summary

Archive	getEnclArchive()
String	getPath() Returns the canonical path of the archive file.

Method Detail

getPath

String getPath()

Returns the canonical path of the archive file. A canonical path is both absolute and unique. The precise definition depends on the platform, but all elements in a canonical path are separated by File.separators.

This property may be used to determine some archive file specific parameters, such as passwords or similar. However, implementations must not assume that the file denoted by the path actually exists as a file in the native file system!

Returns:

A valid reference to a String object - never null.

See Also:

getEnclArchive()

getEnclArchive

Archive getEnclArchive()

Returns:

The enclosing archive or null if this archive is not enclosed in another archive