/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2001 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.masterfs.providers;

import org.netbeans.modules.masterfs.providers.AutoMountProvider;

/**
 *
 * An object that implements FileSystemProvider have chance to affect behaviour of
 * MasterFileSystem. MasterFileSystem delegates its functionality to mounted FileSystems.
 * So, behaviour of MasterFileSystem can be affected easily by mounting its own
 * implemenation of FileSystem.
 *
 * 
There are two ways how to mount FileSystem into MasterFileSystem:
 * 

 * 
 automatic mounting means,
 * that there is not necessary to call MountSupport
 * to mount filesystem into MasterFileSystem. On the contrary MasterFileSystem
 * invokes individual AutoMountProviders to obtain instance of FileSystem, that should
 * be mounted. Then {@link org.netbeans.modules.masterfs.providers.AutoMountProvider}
 * must be able to return best suited filesystem for passed mount point or null.
 *

 * 
 * 
 user mounting is simply {@link org.netbeans.modules.masterfs.providers.MountSupport},
 * which is API, that has two methods mount and unmount.
 * 
 * 
 

 *
 *
 * @see org.netbeans.modules.masterfs.providers.MountSupport
 * @see org.netbeans.modules.masterfs.providers.AutoMountProvider
 * @author  rm111737
 */
public abstract interface FileSystemProvider {
    /**
     * Implementation of method initialize may support:
     * 

     * 
 automatic mounting, then method initialize mustn't return null. 
     * 
 user mounting, then MountSupport passed to method initalize needs to be kept.
     * 
 both above mentioned
     * 
     * @param mSupport instance of MountSupport provided by MasterFileSystem
     * @return  instance of  AutoMountProvider if there is supported automatic mounting
     */
    public abstract AutoMountProvider initialize (MountSupport mSupport);

}