View Javadoc
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  /**
22   * Provides information about ArchiveEntry stream offsets.
23   */
24  public interface EntryStreamOffsets {
25  
26      /**
27       * Indicates that the offset is unknown.
28       */
29      long OFFSET_UNKNOWN = -1;
30  
31      /**
32       * Gets the offset of data stream within the archive file,
33       *
34       * @return the offset of entry data stream, {@code OFFSET_UNKNOWN} if not known.
35       */
36      long getDataOffset();
37  
38      /**
39       * Tests whether the stream is contiguous, that is, not split among several archive parts, interspersed with control blocks, and so on.
40       *
41       * @return true if stream is contiguous, false otherwise.
42       */
43      boolean isStreamContiguous();
44  }