Package jenkins.plugins.nodejs.tools

Class NodeJSVersionRange

java.lang.Object
jenkins.plugins.nodejs.tools.NodeJSVersionRange
public class NodeJSVersionRange extends Object
Version range. A version range is an interval describing a set of versions.

A range has a left (lower) endpoint and a right (upper) endpoint. Each endpoint can be open (excluded from the set) or closed (included in the set).

NodeJSVersionRange objects are immutable.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final char
    LEFT_CLOSED
    The left endpoint is closed and is included in the range.
    static final char
    LEFT_OPEN
    The left endpoint is open and is excluded from the range.
    static final char
    RIGHT_CLOSED
    The right endpoint is closed and is included in the range.
    static final char
    RIGHT_OPEN
    The right endpoint is open and is excluded from the range.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NodeJSVersionRange(String range)
    Creates a version range from the specified string.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object object)
    Compares this VersionRange object to another object.
    NodeJSVersion
    getLeft()
    Returns the left endpoint of this version range.
    char
    getLeftType()
    Returns the type of the left endpoint of this version range.
    NodeJSVersion
    getRight()
    Returns the right endpoint of this version range.
    char
    getRightType()
    Returns the type of the right endpoint of this version range.
    int
    hashCode()
    Returns a hash code value for the object.
    boolean
    includes(NodeJSVersion version)
    Returns whether this version range includes the specified version.
    boolean
    isEmpty()
    Returns whether this version range is empty.
    String
    toString()
    Returns the string representation of this version range.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • LEFT_OPEN

      public static final char LEFT_OPEN
      The left endpoint is open and is excluded from the range.

      The value of LEFT_OPEN is '('.

      See Also:

    • LEFT_CLOSED

      public static final char LEFT_CLOSED
      The left endpoint is closed and is included in the range.

      The value of LEFT_CLOSED is '['.

      See Also:

    • RIGHT_OPEN

      public static final char RIGHT_OPEN
      The right endpoint is open and is excluded from the range.

      The value of RIGHT_OPEN is ')'.

      See Also:

    • RIGHT_CLOSED

      public static final char RIGHT_CLOSED
      The right endpoint is closed and is included in the range.

      The value of RIGHT_CLOSED is ']'.

      See Also:

  • Constructor Details

    • NodeJSVersionRange

      public NodeJSVersionRange(String range)
      Creates a version range from the specified string.

      Version range string grammar: 

       range ::= interval | atleast
 interval ::= ( '[' | '(' ) left ',' right ( ']' | ')' )
 left ::= version
 right ::= version
 atleast ::= version
      Parameters:
      range - String representation of the version range. The versions in the range must contain no whitespace. Other whitespace in the range string is ignored.
      Throws:
      IllegalArgumentException - If range is improperly formatted.

  • Method Details

    • getLeft

      public NodeJSVersion getLeft()
      Returns the left endpoint of this version range.
      Returns:
      The left endpoint.

    • getRight

      public NodeJSVersion getRight()
      Returns the right endpoint of this version range.
      Returns:
      The right endpoint. May be null which indicates the right endpoint is Infinity.

    • getLeftType

      public char getLeftType()
      Returns the type of the left endpoint of this version range.
      Returns:
      LEFT_CLOSED if the left endpoint is closed or LEFT_OPEN if the left endpoint is open.

    • getRightType

      public char getRightType()
      Returns the type of the right endpoint of this version range.
      Returns:
      RIGHT_CLOSED if the right endpoint is closed or RIGHT_OPEN if the right endpoint is open.

    • includes

      public boolean includes(NodeJSVersion version)
      Returns whether this version range includes the specified version.
      Parameters:
      version - The version to test for inclusion in this version range.
      Returns:
      true if the specified version is included in this version range; false otherwise.

    • isEmpty

      public boolean isEmpty()
      Returns whether this version range is empty. A version range is empty if the set of versions defined by the interval is empty.
      Returns:
      true if this version range is empty; false otherwise.

    • toString

      public String toString()
      Returns the string representation of this version range.

      The format of the version range string will be a version string if the right end point is Infinity (null) or an interval string.

      Overrides:
      toString in class Object
      Returns:
      The string representation of this version range.

    • hashCode

      public int hashCode()
      Returns a hash code value for the object.
      Overrides:
      hashCode in class Object
      Returns:
      An integer which is a hash code value for this object.

    • equals

      public boolean equals(Object object)
      Compares this VersionRange object to another object.

      A version range is considered to be equal to another version range if both the endpoints and their types are equal or if both version ranges are empty.

      Overrides:
      equals in class Object
      Parameters:
      object - The VersionRange object to be compared.
      Returns:
      true if object is a VersionRange and is equal to this object; false otherwise.