ARCLocation.java

/*
 *  This file is part of the Heritrix web crawler (crawler.archive.org).
 *
 *  Licensed to the Internet Archive (IA) by one or more individual 
 *  contributors. 
 *
 *  The IA licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.archive.io.arc;

/**
 * Datastructure to hold ARC record location.
 * Used by wayback machine.
 * @author stack
 */
public interface ARCLocation {
    /**
     * @return Returns the ARC filename.  Can be full path to ARC, URL to an
     * ARC or just the portion of an ARC name that is unique to a collection.
     */
    public String getName();

    /**
     * @return Returns the offset into the ARC.
     */
    public long getOffset();
}