    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one
    003 * or more contributor license agreements.  See the NOTICE file
    004 * distributed with this work for additional information
    005 * regarding copyright ownership.  The ASF licenses this file
    006 * to you under the Apache License, Version 2.0 (the
    007 * "License"); you may not use this file except in compliance
    008 * with the License.  You may obtain a copy of the License at
    009 *
    010 * http://www.apache.org/licenses/LICENSE-2.0
    011 *
    012 * Unless required by applicable law or agreed to in writing,
    013 * software distributed under the License is distributed on an
    014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    015 * KIND, either express or implied.  See the License for the
    016 * specific language governing permissions and limitations
    017 * under the License.
    018 */
    019package org.apache.commons.compress.archivers;
    020
    021/**
    022 * Provides information about ArchiveEntry stream offsets.
    023 */
    024public interface EntryStreamOffsets {
    025
    026    /**
    027     * Indicates that the offset is unknown.
    028     */
    029    long OFFSET_UNKNOWN = -1;
    030
    031    /**
    032     * Gets the offset of data stream within the archive file,
    033     *
    034     * @return the offset of entry data stream, {@code OFFSET_UNKNOWN} if not known.
    035     */
    036    long getDataOffset();
    037
    038    /**
    039     * Tests whether the stream is contiguous, that is, not split among several archive parts, interspersed with control blocks, and so on.
    040     *
    041     * @return true if stream is contiguous, false otherwise.
    042     */
    043    boolean isStreamContiguous();
    044}