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.vfs.provider.compressed;
18  
19  import org.apache.commons.vfs.FileName;
20  import org.apache.commons.vfs.FileObject;
21  import org.apache.commons.vfs.FileSystem;
22  import org.apache.commons.vfs.FileSystemException;
23  import org.apache.commons.vfs.FileSystemOptions;
24  import org.apache.commons.vfs.provider.AbstractFileSystem;
25  
26  import java.util.Collection;
27  
28  /***
29   * A read-only file system for compressed files.
30   *
31   * @author <a href="mailto:imario@apache.org">Mario Ivankovits</a>
32   * @version $Revision: 480428 $ $Date: 2006-11-29 07:15:24 +0100 (Mi, 29 Nov 2006) $
33   */
34  public abstract class CompressedFileFileSystem
35      extends AbstractFileSystem
36      implements FileSystem
37  {
38      protected CompressedFileFileSystem(final FileName rootName,
39                                         final FileObject parentLayer,
40                                         final FileSystemOptions fileSystemOptions)
41          throws FileSystemException
42      {
43          super(rootName, parentLayer, fileSystemOptions);
44      }
45  
46      public void init() throws FileSystemException
47      {
48          super.init();
49  
50      }
51  
52      /***
53       * Returns the capabilities of this file system.
54       */
55      protected abstract void addCapabilities(final Collection caps);
56  
57      /***
58       * Creates a file object.
59       */
60      protected abstract FileObject createFile(final FileName name) throws FileSystemException;
61  }