    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/**
    023 * Provides information about ArchiveEntry stream offsets.
    024 */
    025public interface EntryStreamOffsets {
    026
    027    /** Special value indicating that the offset is unknown. */
    028    long OFFSET_UNKNOWN = -1;
    029
    030    /**
    031     * Gets the offset of data stream within the archive file,
    032     *
    033     * @return
    034     *      the offset of entry data stream, {@code OFFSET_UNKNOWN} if not known.
    035     */
    036    long getDataOffset();
    037
    038    /**
    039     * Indicates whether the stream is contiguous, i.e. not split among
    040     * several archive parts, interspersed with control blocks, etc.
    041     *
    042     * @return
    043     *      true if stream is contiguous, false otherwise.
    044     */
    045    boolean isStreamContiguous();
    046}