org.openide.filesystems.spi

Interface ArchiveRootProvider

public interface ArchiveRootProvider

A possibility to plug a support for java archives into FileUtil. The interface is used by FileUtil.isArchiveArtifact, FileUtil.isArchiveFile, FileUtil.getArchiveRoot, FileUtil.getArchiveFile. The implementations are registered in global lookup.

Since:

9.10

Method Summary

Modifier and Type	Method and Description
default FileObject	getArchiveFile(FileObject fo) Returns a FileObject representing an archive file containing the FileObject given by the parameter.
URL	getArchiveFile(URL url) Returns the URL of the archive file containing the file referred to by a archive-protocol URL.
default FileObject	getArchiveRoot(FileObject fo) Returns a FileObject representing the root folder of an archive.
URL	getArchiveRoot(URL url) Returns an URL representing the root of an archive.
default boolean	isArchiveArtifact(FileObject fo) Tests if an file is inside an archive.
boolean	isArchiveArtifact(URL url) Tests if an URL denotes a file inside an archive.
default boolean	isArchiveFile(FileObject fo, boolean strict) Tests if a file represents an java archive.
boolean	isArchiveFile(URL url, boolean strict) Tests if a file represents an java archive.

Method Detail

isArchiveFile

boolean isArchiveFile(URL url,
                      boolean strict)

Tests if a file represents an java archive.

Parameters:

url - the file to be tested

strict - when false the detection may not be precise, for example an empty archive missing the archive header is treated as an archive

Returns:

true if the file looks like an archive

isArchiveFile

default boolean isArchiveFile(FileObject fo,
                              boolean strict)

Tests if a file represents an java archive. The default implementation delegates to ArchiveRootProvider.isArchiveFile(URL, boolean), it can be overridden by an implementation in more efficient way.

Parameters:

fo - the file to be tested

strict - when false the detection may not be precise, for example an empty archive missing the archive header is treated as an archive

Returns:

true if the file looks like an archive

isArchiveArtifact

boolean isArchiveArtifact(URL url)

Tests if an URL denotes a file inside an archive.

Parameters:

url - the url to be tested

Returns:

true if the url points inside an archive

isArchiveArtifact

default boolean isArchiveArtifact(FileObject fo)

Tests if an file is inside an archive. The default implementation delegates to ArchiveRootProvider.isArchiveArtifact(URL), it can be overridden by an implementation in more efficient way.

Parameters:

fo - the file to be tested

Returns:

true if the file is inside an archive

getArchiveFile

URL getArchiveFile(URL url)

Returns the URL of the archive file containing the file referred to by a archive-protocol URL. Remember that any path within the archive is discarded so you may need to check for non-root entries.

Parameters:

url - a URL

Returns:

the embedded archive URL, or null if the URL is not an archive-protocol URL containing !/

getArchiveFile

default FileObject getArchiveFile(FileObject fo)

Returns a FileObject representing an archive file containing the FileObject given by the parameter. Remember that any path within the archive is discarded so you may need to check for non-root entries. The default implementation delegates to ArchiveRootProvider.getArchiveFile(URL), it can be overridden by an implementation in more efficient way.

Parameters:

fo - a file in a archive filesystem

Returns:

the file corresponding to the archive itself, or null if fo is not an archive entry

getArchiveRoot

URL getArchiveRoot(URL url)

Returns an URL representing the root of an archive. Clients may need to first call #isArchiveFile(URL) to determine if the URL refers to an archive file.

Parameters:

url - of an java archive file

Returns:

the archive-protocol URL of the root of the archive

getArchiveRoot

default FileObject getArchiveRoot(FileObject fo)

Returns a FileObject representing the root folder of an archive. Clients may need to first call #isArchiveFile(FileObject) to determine if the file object refers to an archive file. The default implementation delegates to ArchiveRootProvider.getArchiveRoot(URL), it can be overridden by an implementation in more efficient way.

Parameters:

fo - an java archive file

Returns:

a virtual archive root folder, or null if the file is not actually an archive