View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.vfs2.provider.compressed;
18  
19  import java.util.Collection;
20  
21  import org.apache.commons.vfs2.Capability;
22  import org.apache.commons.vfs2.FileName;
23  import org.apache.commons.vfs2.FileObject;
24  import org.apache.commons.vfs2.FileSystemException;
25  import org.apache.commons.vfs2.FileSystemOptions;
26  import org.apache.commons.vfs2.provider.AbstractFileName;
27  import org.apache.commons.vfs2.provider.AbstractFileSystem;
28  
29  /**
30   * A read-only file system for compressed files.
31   */
32  public abstract class CompressedFileFileSystem
33      extends AbstractFileSystem
34  {
35      protected CompressedFileFileSystem(final FileName rootName,
36                                         final FileObject parentLayer,
37                                         final FileSystemOptions fileSystemOptions)
38      {
39          super(rootName, parentLayer, fileSystemOptions);
40      }
41  
42      /**
43       * Returns the capabilities of this file system.
44       */
45      @Override
46      protected abstract void addCapabilities(final Collection<Capability> caps);
47  
48      /**
49       * Creates a file object.
50       */
51      @Override
52      protected abstract FileObject createFile(final AbstractFileName name) throws FileSystemException;
53  }