org.lockss.daemon.CachedUrlSetSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lockss-core Show documentation
The Slimmed Down LOCKSS Daemon Core
The newest version!
/*
 * $Id$
 */

/*

Copyright (c) 2000-2005 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
STANFORD UNIVERSITY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of Stanford University shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Stanford University.

*/

package org.lockss.daemon;

/**
 * Specifies a set of URLs, all having a common root (URL prefix).  Used by
 * CachedUrlSet to determine which URLs are included.
 */
public interface CachedUrlSetSpec {
  /**
   * Determine whether a url is part of this CachedUrlSetSpec.
   * @param url The url.
   * @return true iff the url is contained in the set described by the spec
   */
  public boolean matches(String url);

  /**
   * Return the hashcode of the CachedUrlSetSpec.  Must be implemented by
   * implementors of this interface.
   * @return the hashcode
   */
  public int hashCode();

  /**
   * Compare the CachedUrlSetSpec with another object.  Must be implemented
   * by implementors of this interface.
   * @param obj the object to compare to
   * @return true if the objects are equal
   */
  public boolean equals(Object obj);

  /**
   * Return the common URL prefix.
   * @return the url
   */
  public String getUrl();

  /**
   * Return true if this set is disjoint from the argument set.  It is not
   * meaningful to compare CUSSes belonging to different AUs.
   * @param spec the set to test disjointness with
   * @return true if the two sets are disjoint
   */
  public boolean isDisjoint(CachedUrlSetSpec spec);

  /**
   * Return true if this set completely contains the argument set.  It is
   * not meaningful to compare CUSSes belonging to different AUs.
   * @param spec the set to test subsumption of
   * @return true if the set specified by spec is subsumed by
   * this one.
   */
  public boolean subsumes(CachedUrlSetSpec spec);

  /**
   * Return true if the CachedUrlSetSpec specifies an entire AU.
   * @return true if an AUCUSS
   */
  public boolean isAu();

  /**
   * Return true if the CachedUrlSetSpec specifies the content at a single
   * node.
   * @return true if a SNCUSS
   */
  public boolean isSingleNode();

  /**
   * Return true if the CachedUrlSetSpec specifies a range of child nodes.
   * This should return true only for RangeCachedUrlSetSpecs that have a
   * non-null lower or upper bound.
   * @return true if a range restricted RangeCachedUrlSetSpec
   */
  public boolean isRangeRestricted();
}