net.ossindex.version.IVersionRange Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of heuristic-version Show documentation
Utility classes that help parse and compare version strings
The newest version!
/**
 * Copyright (c) 2016 Vör Security Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * * Neither the name of the  nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package net.ossindex.version;

/** Interface that all range implementations need to implement.
 *
 * @author Ken Duck
 *
 */
public interface IVersionRange
    extends Comparable
{
  /**
   *
   */
  public abstract boolean contains(IVersion version);

  /** Returns true if this range is a simple singular version
   *
   */
  public abstract boolean isDiscrete();

  /** Return the minimum version that satisfies this range
   *
   */
  public abstract IVersion getMinimum();

  /** Return the maximum version that satisfies this range
   *
   */
  public abstract IVersion getMaximum();

  /** Return true if this is a simple range which has no gaps
   *
   */
  public abstract boolean isSimple();

  /** Check if two ranges intersect
   *
   */
  public abstract boolean intersects(IVersionRange yourRange);

  /**
   * Check if one range contains another range.
   */
  public abstract boolean contains(IVersionRange trange);

  /**
   * Get a simplified version range, suitable for users to read quickly
   */
  public abstract IVersionRange getSimplifiedRange();

  /**
   * Get the range type
   */
  public abstract String getType();

  /**
   * Give the range a type. This indicates the "style" of the range.
   */
  public abstract void setType(String type);

  public abstract void setHasErrors(boolean b);

  public abstract boolean hasErrors();

  /**
   * Generate a range that is the inverse of the provided range
   */
  public abstract IVersionRange invert();

  /**
   * Returns version range in maven syntax
   */
  public abstract String toMavenString();
}