Apache Mina SSHD 2.15.0 · org.apache.sshd.common.util.VersionInfo

Modifier and Type	Field and Description
private final int	buildNumber
private final int	majorVersion
private final int	minorVersion
private final int	release
private static final long	serialVersionUID

Access	Constructor and Description
public	VersionInfo(int major, int minor)
public	VersionInfo(int major, int minor, int release, int build)

Modifier and Type	Method and Description
public int	compareTo(VersionInfo the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final int	getBuildNumber()
public final int	getMajorVersion()
public final int	getMinorVersion()
public final int	getRelease()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static VersionInfo	Returns: The parsed `VersionInfo` - or `null` if empty input parse(String The version string - ignored if `null`/empty version) Parses a version string - assumed to contain at most 4 non-negative components separated by a '.'.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

buildNumber	back to summary
private final int buildNumber

majorVersion	back to summary
private final int majorVersion

minorVersion	back to summary
private final int minorVersion

release	back to summary
private final int release

serialVersionUID	back to summary
private static final long serialVersionUID

VersionInfo	back to summary
public VersionInfo(int major, int minor)

VersionInfo	back to summary
public VersionInfo(int major, int minor, int release, int build)

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(VersionInfo o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:VersionInfo the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(VersionInfo o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:VersionInfo: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getBuildNumber	back to summary
public final int getBuildNumber()

getMajorVersion	back to summary
public final int getMajorVersion()

getMinorVersion	back to summary
public final int getMinorVersion()

getRelease	back to summary
public final int getRelease()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

parse back to summary

parse	back to summary
public static VersionInfo parse(String version) throws NumberFormatException Parses a version string - assumed to contain at most 4 non-negative components separated by a '.'. If less than 4 components are found, then the rest are assumed to be zero. If more than 4 components found, then only the 1st ones are parsed. Parameters version:String The version string - ignored if `null`/empty Returns:VersionInfo The parsed `VersionInfo` - or `null` if empty input Exceptions NumberFormatException: If failed to parse any of the components IllegalArgumentException: If any of the parsed components is negative

public static VersionInfo parse(String version) throws NumberFormatException

Parses a version string - assumed to contain at most 4 non-negative components separated by a '.'. If less than 4 components are found, then the rest are assumed to be zero. If more than 4 components found, then only the 1st ones are parsed.

Parameters

version:String: The version string - ignored if null/empty

Returns:VersionInfo

The parsed VersionInfo - or null if empty input

Exceptions

NumberFormatException:: If failed to parse any of the components
IllegalArgumentException:: If any of the parsed components is negative

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class VersionInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail