net.java.truevfs.access

Class TArchiveDetector

java.lang.Object

net.java.truevfs.kernel.spec.FsAbstractCompositeDriver

net.java.truevfs.access.TArchiveDetector

All Implemented Interfaces:

javax.inject.Provider<Map<FsScheme,FsDriver>>, net.java.truecommons.services.Container<Map<FsScheme,FsDriver>>, FsCompositeDriver, FsController.Factory<FsManager>, FsModel.Factory<FsManager>

@Immutable
public final class TArchiveDetector
extends FsAbstractCompositeDriver

Detects a prospective archive file and declares its file system scheme by mapping its file name extension to an archive driver. Note that this class does not access any file system!

The map of detectable archive file name extensions and corresponding archive drivers is configured by the constructors of this class. There are two types of constructors available:

1. Constructors which filter the driver map of a given file system driver provider by a given list of file name extensions. For example, the driver map of the provider FsDriverMapLocator.SINGLETON could be filtered by the file name extension list "tar|zip" in order to recognize only TAR and ZIP files.
2. Constructors which decorate a given file system driver provider with a given map of file system schemes to file system drivers. This can get used to specify custom archive file name extensions or archive drivers. For example, the file name extension list "foo|bar" could be used to detect a custom variant of the JAR file format (you need to provide a custom archive driver then, too).

Where a constructor expects a list of file name extensions as a parameter, it must obeye the syntax constraints for ExtensionSets. As an example, the parameter "zip|jar" would cause the archive detector to recognize ZIP and JAR files in a path. The same would be true for "||.ZiP||.JaR||ZIP||JAR||", but this notation is discouraged because it's not in canonical form.

Author:

Christian Schlichtherle

Field Summary

Fields

Modifier and Type	Field and Description
static TArchiveDetector	ALL This instance recognizes all archive file name extensions for which an archive driver can get located on the class path by the file system driver map locator singleton FsDriverMapLocator.SINGLETON.
static TArchiveDetector	NULL This instance never recognizes any archive files in a path.

Constructor Summary

Constructors

Constructor and Description
TArchiveDetector(javax.inject.Provider<Map<FsScheme,FsDriver>> provider, Map<FsScheme,FsDriver> config) Constructs a new TArchiveDetector by decorating the given driver provider with mappings for all entries in config.
TArchiveDetector(javax.inject.Provider<Map<FsScheme,FsDriver>> provider, Object[][] config) Creates a new TArchiveDetector by decorating the configuration of provider with mappings for all entries in config.
TArchiveDetector(javax.inject.Provider<Map<FsScheme,FsDriver>> provider, String extensions) Constructs a new TArchiveDetector by filtering the given driver provider for all canonicalized extensions in the extensions list.
TArchiveDetector(javax.inject.Provider<Map<FsScheme,FsDriver>> provider, String extensions, FsDriver driver) Constructs a new TArchiveDetector by decorating the configuration of provider with mappings for all canonicalized extensions in extensions to driver.
TArchiveDetector(String extensions) Equivalent to TArchiveDetector(FsDriverMapLocator.SINGLETON, extensions).
TArchiveDetector(String extensions, FsDriver driver) Equivalent to TArchiveDetector(TArchiveDetector.NULL, extensions, driver).

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Map<FsScheme,FsDriver>	get()
Map<FsScheme,FsDriver>	getDrivers() Returns the immutable map of file system drivers.
String	getExtensions() Returns the canonical extension list for all archive file system schemes recognized by this TArchiveDetector.
int	hashCode()
FsScheme	scheme(String path) Detects whether the given path name identifies a prospective archive file by matching its file name extension against the set of file system schemes in the file system driver map.
String	toString()

Methods inherited from class net.java.truevfs.kernel.spec.FsAbstractCompositeDriver

newController, newModel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final TArchiveDetector ALL

This instance recognizes all archive file name extensions for which an archive driver can get located on the class path by the file system driver map locator singleton FsDriverMapLocator.SINGLETON.

NULL

public static final TArchiveDetector NULL

This instance never recognizes any archive files in a path. This can get used as the end of a chain of TArchiveDetector instances or if archive files shall be treated like regular files rather than (virtual) directories.

Constructor Detail

TArchiveDetector

public TArchiveDetector(javax.inject.Provider<Map<FsScheme,FsDriver>> provider,
                        Map<FsScheme,FsDriver> config)

Constructs a new TArchiveDetector by decorating the given driver provider with mappings for all entries in config.

Parameters:

provider - the file system driver provider to decorate.

config - a map of file system schemes to file system drivers. null may be used to shadow a mapping for an equal file system scheme in provider by removing it from the resulting map for this detector.

Throws:

NullPointerException - if a required configuration element is null.

ClassCastException - if a configuration element is of the wrong type.

IllegalArgumentException - if any other parameter precondition does not hold.

See Also:

Syntax contraints for extension lists.

TArchiveDetector

public TArchiveDetector(javax.inject.Provider<Map<FsScheme,FsDriver>> provider,
                        Object[][] config)

Creates a new TArchiveDetector by decorating the configuration of provider with mappings for all entries in config.

Parameters:

provider - the file system driver provider to decorate.

config - an array of key-value pair arrays. The first element of each inner array must either be a file system scheme, an object o which can get converted to a set of file name extensions by calling new ExtensionSet(o.toString()) or a collection of these. The second element of each inner array must either be a file system driver object, a file system driver class, a fully qualified name of a file system driver class, or null. null may be used to shadow a mapping for an equal file system scheme in provider by removing it from the resulting map for this detector.

Throws:

NullPointerException - if a required configuration element is null.

IllegalArgumentException - if any other parameter precondition does not hold.

See Also:

Syntax contraints for extension lists.

TArchiveDetector

public TArchiveDetector(javax.inject.Provider<Map<FsScheme,FsDriver>> provider,
                        @CheckForNull
                        String extensions)

Constructs a new TArchiveDetector by filtering the given driver provider for all canonicalized extensions in the extensions list.

Parameters:

provider - the file system driver provider to filter.

extensions - A list of file name extensions which shall identify prospective archive files. If this is null, no filtering is applied and all drivers known by the given provider are available for use with this archive detector.

Throws:

IllegalArgumentException - If any of the extensions in the list names a extension for which no file system driver is known by the provider.

See Also:

Syntax constraints for extension lists.

TArchiveDetector

public TArchiveDetector(javax.inject.Provider<Map<FsScheme,FsDriver>> provider,
                        String extensions,
                        @CheckForNull
                        FsDriver driver)

Constructs a new TArchiveDetector by decorating the configuration of provider with mappings for all canonicalized extensions in extensions to driver.

Parameters:

provider - the file system driver provider to decorate.

extensions - A list of file name extensions which shall identify prospective archive files. This must not be null and must not be empty.

driver - the file system driver to map for the extension list. null may be used to shadow a mapping for an equal file system scheme in provider by removing it from the resulting map for this detector.

Throws:

NullPointerException - if a required configuration element is null.

IllegalArgumentException - if any other parameter precondition does not hold.

See Also:

Syntax contraints for extension lists.

TArchiveDetector

public TArchiveDetector(@CheckForNull
                        String extensions)

Equivalent to TArchiveDetector(FsDriverMapLocator.SINGLETON, extensions).

TArchiveDetector

public TArchiveDetector(String extensions,
                        @CheckForNull
                        FsDriver driver)

Equivalent to TArchiveDetector(TArchiveDetector.NULL, extensions, driver).

Method Detail

equals

public boolean equals(Object other)

Overrides:

equals in class Object

get

public Map<FsScheme,FsDriver> get()

getDrivers

public Map<FsScheme,FsDriver> getDrivers()

Returns the immutable map of file system drivers. This is equivalent to get().

Returns:

the immutable map of file system drivers.

getExtensions

public String getExtensions()

Returns the canonical extension list for all archive file system schemes recognized by this TArchiveDetector.

Returns:

Either "" to indicate an empty set or a string of the form "extension[|extension]*", where extension is a combination of lower case letters which does not start with a dot. The string never contains empty or duplicated extensions and the extensions are sorted in natural order.

See Also:

TArchiveDetector(String), Syntax constraints for extension lists.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

scheme

@CheckForNull
public FsScheme scheme(String path)

Detects whether the given path name identifies a prospective archive file by matching its file name extension against the set of file system schemes in the file system driver map. If a match is found, the file name extension gets converted to a file system scheme and returned. Otherwise, null is returned.

Parameters:

path - the path name.

Returns:

A file system scheme to declare the file system type of the prospective archive file or null if no archive file name extension has been detected.

toString

public String toString()

Overrides:

toString in class Object