/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.commons.vfs2.provider.compressed;
  
  import java.util.Collection;
  
  import org.apache.commons.vfs2.Capability;
  import org.apache.commons.vfs2.FileName;
  import org.apache.commons.vfs2.FileObject;
  import org.apache.commons.vfs2.FileSystem;
  import org.apache.commons.vfs2.FileSystemException;
  import org.apache.commons.vfs2.FileSystemOptions;
  import org.apache.commons.vfs2.FileType;
  import org.apache.commons.vfs2.provider.AbstractLayeredFileProvider;
  import org.apache.commons.vfs2.provider.LayeredFileName;
  
  /**
   * A file system provider for compressed files. Provides read-only file systems.
   */
  public abstract class CompressedFileFileProvider extends AbstractLayeredFileProvider {
  
      public CompressedFileFileProvider() {
      }
  
      /**
       * Creates a layered file system. This method is called if the file system is not cached.
       *
       * @param scheme The URI scheme.
       * @param file The file to create the file system on top of.
       * @return The file system.
       */
      @Override
      protected FileSystem doCreateFileSystem(final String scheme, final FileObject file,
              final FileSystemOptions fileSystemOptions) throws FileSystemException {
          final FileName name = new LayeredFileName(scheme, file.getName(), FileName.ROOT_PATH, FileType.FOLDER);
          return createFileSystem(name, file, fileSystemOptions);
      }
  
      protected abstract FileSystem createFileSystem(final FileName name, final FileObject file,
              final FileSystemOptions fileSystemOptions) throws FileSystemException;
  
      @Override
      public abstract Collection<Capability> getCapabilities();
  }