View Javadoc

    1   /* ARCLocation
    2    *
    3    * $Id: ARCLocation.java 4431 2006-08-04 00:13:51Z stack-sf $
    4    *
    5    * Created on April 27, 2005.
    6    *
    7    * Copyright (C) 2005 Internet Archive.
    8    *
    9    * This file is part of the Heritrix web crawler (crawler.archive.org).
    10   *
    11   * Heritrix is free software; you can redistribute it and/or modify
    12   * it under the terms of the GNU Lesser Public License as published by
    13   * the Free Software Foundation; either version 2.1 of the License, or any
    14   * later version.
    15   *
    16   * The archive-access tools are distributed in the hope that they will be
    17   * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
    18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
    19   * Public License for more details.
    20   *
    21   * You should have received a copy of the GNU Lesser Public License along with
    22   * the archive-access tools; if not, write to the Free Software Foundation,
    23   * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
    24   */
    25  package org.archive.io.arc;
    26
    27  /***
    28   * Datastructure to hold ARC record location.
    29   * Used by wayback machine.
    30   * @author stack
    31   */
    32  public interface ARCLocation {
    33      /***
    34       * @return Returns the ARC filename.  Can be full path to ARC, URL to an
    35       * ARC or just the portion of an ARC name that is unique to a collection.
    36       */
    37      public String getName();
    38
    39      /***
    40       * @return Returns the offset into the ARC.
    41       */
    42      public long getOffset();
    43  }