• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements.  See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership.  The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License.  You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied.  See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 package org.apache.commons.compress.archivers;
20 
21 import java.util.Date;
22 
23 /**
24  * Represents an entry of an archive.
25  */
26 public interface ArchiveEntry {
27 
28     /**
29      * Gets the name of the entry in this archive. May refer to a file or directory or other item.
30      *
31      * <p>This method returns the raw name as it is stored inside of the archive.</p>
32      *
33      * @return The name of this entry in the archive.
34      */
getName()35     String getName();
36 
37     /**
38      * Gets the uncompressed size of this entry. May be -1 (SIZE_UNKNOWN) if the size is unknown
39      *
40      * @return the uncompressed size of this entry.
41      */
getSize()42     long getSize();
43 
44     /** Special value indicating that the size is unknown */
45     long SIZE_UNKNOWN = -1;
46 
47     /**
48      * Returns true if this entry refers to a directory.
49      *
50      * @return true if this entry refers to a directory.
51      */
isDirectory()52     boolean isDirectory();
53 
54     /**
55      * Gets the last modified date of this entry.
56      *
57      * @return the last modified date of this entry.
58      * @since 1.1
59      */
getLastModifiedDate()60     Date getLastModifiedDate();
61 }
62