001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.provider.compressed;
018
019import java.util.Collection;
020
021import org.apache.commons.vfs2.Capability;
022import org.apache.commons.vfs2.FileName;
023import org.apache.commons.vfs2.FileObject;
024import org.apache.commons.vfs2.FileSystemException;
025import org.apache.commons.vfs2.FileSystemOptions;
026import org.apache.commons.vfs2.provider.AbstractFileName;
027import org.apache.commons.vfs2.provider.AbstractFileSystem;
028
029/**
030 * A read-only file system for compressed files.
031 */
032public abstract class CompressedFileFileSystem extends AbstractFileSystem {
033    protected CompressedFileFileSystem(final FileName rootName, final FileObject parentLayer,
034            final FileSystemOptions fileSystemOptions) {
035        super(rootName, parentLayer, fileSystemOptions);
036    }
037
038    /**
039     * Returns the capabilities of this file system.
040     */
041    @Override
042    protected abstract void addCapabilities(final Collection<Capability> caps);
043
044    /**
045     * Creates a file object.
046     */
047    @Override
048    protected abstract FileObject createFile(final AbstractFileName name) throws FileSystemException;
049}