jenkins.plugins.nodejs.tools

Class NodeJSVersion

java.lang.Object

jenkins.plugins.nodejs.tools.NodeJSVersion

All Implemented Interfaces:

Comparable<NodeJSVersion>

public class NodeJSVersion
extends Object
implements Comparable<NodeJSVersion>

NodeJSVersion identifier.

NodeJSVersion identifiers have tree components.

1. Major version. A non-negative integer.
2. Minor version. A non-negative integer.
3. Micro version. A non-negative integer.

NodeJSVersion objects are immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static NodeJSVersion	emptyVersion The empty version "0.0.0".

Constructor Summary

Constructors

Constructor and Description
NodeJSVersion(int major, int minor, int micro) Creates a version identifier from the specified numerical components.
NodeJSVersion(String version) Creates a version identifier from the specified string.

Method Summary

Modifier and Type	Method and Description
int	compareTo(NodeJSVersion other) Compares this NodeJSVersion object to another NodeJSVersion.
boolean	equals(Object object) Compares this NodeJSVersion object to another object.
int	getMajor() Returns the major component of this version identifier.
int	getMicro() Returns the micro component of this version identifier.
int	getMinor() Returns the minor component of this version identifier.
int	hashCode() Returns a hash code value for the object.
static NodeJSVersion	parseVersion(String version) Parses a version identifier from the specified string.
String	toString() Returns the string representation of this version identifier.

Methods inherited from class java.lang.Object

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

Field Detail

emptyVersion

public static final NodeJSVersion emptyVersion

The empty version "0.0.0".

Constructor Detail

NodeJSVersion

public NodeJSVersion(int major,
                     int minor,
                     int micro)

Creates a version identifier from the specified numerical components.

Parameters:

major - Major component of the version identifier.

minor - Minor component of the version identifier.

micro - Micro component of the version identifier.

Throws:

IllegalArgumentException - If the numerical components are negative.

NodeJSVersion

public NodeJSVersion(String version)

Creates a version identifier from the specified string.

NodeJSVersion string grammar:

 version ::= major('.'minor('.'micro)?)?
 major ::= digit+
 minor ::= digit+
 micro ::= digit+
 digit ::= [0..9]
 

Parameters:

version - String representation of the version identifier. There must be no whitespace in the argument.

Throws:

IllegalArgumentException - If version is improperly formatted.

Method Detail

parseVersion

public static NodeJSVersion parseVersion(String version)

Parses a version identifier from the specified string.

See NodeJSVersion(String) for the format of the version string.

Parameters:

version - String representation of the version identifier. Leading and trailing whitespace will be ignored.

Returns:

A NodeJSVersion object representing the version identifier. If version is null or the empty string then emptyVersion will be returned.

Throws:

IllegalArgumentException - If version is improperly formatted.

getMajor

public int getMajor()

Returns the major component of this version identifier.

Returns:

The major component.

getMinor

public int getMinor()

Returns the minor component of this version identifier.

Returns:

The minor component.

getMicro

public int getMicro()

Returns the micro component of this version identifier.

Returns:

The micro component.

toString

public String toString()

Returns the string representation of this version identifier.

The format of the version string will be major.minor.micro.

Overrides:

toString in class Object

Returns:

The string representation of this version identifier.

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 NodeJSVersion object to another object.

A version is considered to be equal to another version if the major, minor and micro components are equal.

Overrides:

equals in class Object

Parameters:

object - The NodeJSVersion object to be compared.

Returns:

true if object is a NodeJSVersion and is equal to this object; false otherwise.

compareTo

public int compareTo(NodeJSVersion other)

Compares this NodeJSVersion object to another NodeJSVersion.

A version is considered to be less than another version if its major component is less than the other version's major component, or the major components are equal and its minor component is less than the other version's minor component, or the major and minor components are equal and its micro component is less than the other version's micro component, or the major, minor and micro components are equal.

A version is considered to be equal to another version if the major, minor and micro components are equal.

Specified by:

compareTo in interface Comparable<NodeJSVersion>

Parameters:

other - The NodeJSVersion object to be compared.

Returns:

A negative integer, zero, or a positive integer if this version is less than, equal to, or greater than the specified NodeJSVersion object.

Throws:

ClassCastException - If the specified object is not a NodeJSVersion object.