Archive


1   /*
2    * Archive.java
3    *
4    * Created on 2. Maerz 2006, 00:47
5   /*
6    * Copyright 2006 Schlichtherle IT Services
7    *
8    * Licensed under the Apache License, Version 2.0 (the "License");
9    * you may not use this file except in compliance with the License.
10   * You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS,
16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   * See the License for the specific language governing permissions and
18   * limitations under the License.
19   */
20  
21  package de.schlichtherle.io.archive;
22  
23  import de.schlichtherle.io.archive.spi.ArchiveDriver;
24  
25  /**
26   * Describes some properties of an archive.
27   * A single instance of this interface is created for every
28   * canonical path name representation of an archive file.
29   *
30   * @author Christian Schlichtherle
31   * @version @version@
32   * @since TrueZIP 6.0
33   */
34  public interface Archive {
35  
36      /**
37       * Returns the <em>canonical</em> path name of the archive file.
38       * For various reasons, implementations must not assume that the file
39       * identified by the returned path actually exists in the native file
40       * system.
41       * However, the path name may be used to determine some archive
42       * specific parameters, such as passwords or similar.
43       *
44       * @return A valid reference to a {@link String} object
45       *         - never <code>null</code>.
46       */
47      String   getPath();
48      
49      /**
50       * Returns the driver instance which is used for this archive.
51       *
52       * @return A valid reference to an {@link ArchiveDriver} object
53       *         - never <code>null</code>.
54       */
55      //ArchiveDriver getDriver();
56  }
57
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags