Top Description Fields Constructors Methods
com.fasterxml.jackson.core

public Class Version

extends Object
implements Comparable<Version>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.lang.Comparable

Object that encapsulates versioning information of a component. Version information includes not just version number but also optionally group and artifact ids of the component being versioned.

Note that optional group and artifact id properties are new with Jackson 2.0: if provided, they should align with Maven artifact information.

Field Summary

Modifier and TypeField and Description
protected final String
protected final String
protected final int
protected final int
protected final int
protected final String
_snapshotInfo

Additional information for snapshot versions; null for non-snapshot (release) versions.

private static final long
private static final Version

Constructor Summary

AccessConstructor and Description
public
Version(int
Major version number
major
,
int
Minor version number
minor
,
int
patch level of version
patchLevel
,
String
Optional additional string qualifier
snapshotInfo
)

Deprecated Use variant that takes group and artifact ids
public
Version(int major, int minor, int patchLevel, String snapshotInfo, String groupId, String artifactId)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(Version
the object to be compared.
other
)

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.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
public String
public int
public int
public int
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
public boolean

Returns:

True if this instance is the one returned by call to unknownVersion()
isUknownVersion
()

Deprecated Since 2.7 use correctly spelled method isUnknownVersion()
public boolean

Returns:

True if this instance is the one returned by call to unknownVersion()
isUnknownVersion
()

public String
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public static Version

Returns:

Version instance to use as a placeholder when actual version is not known (or not relevant)
unknownVersion
()

Method returns canonical "not known" version, which is used as version in cases where actual version information is not known (instead of null).

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

_artifactIdback to summary
protected final String _artifactId
_groupIdback to summary
protected final String _groupId
_majorVersionback to summary
protected final int _majorVersion
_minorVersionback to summary
protected final int _minorVersion
_patchLevelback to summary
protected final int _patchLevel
_snapshotInfoback to summary
protected final String _snapshotInfo

Additional information for snapshot versions; null for non-snapshot (release) versions.

serialVersionUIDback to summary
private static final long serialVersionUID
UNKNOWN_VERSIONback to summary
private static final Version UNKNOWN_VERSION

Constructor Detail

Versionback to summary
public Version(int major, int minor, int patchLevel, String snapshotInfo)

Deprecated

Use variant that takes group and artifact ids

Parameters
major:int

Major version number

minor:int

Minor version number

patchLevel:int

patch level of version

snapshotInfo:String

Optional additional string qualifier

Annotations
@Deprecated
Since
2.1
Versionback to summary
public Version(int major, int minor, int patchLevel, String snapshotInfo, String groupId, String artifactId)

Method Detail

compareToback to summary
public int compareTo(Version other)

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
other:Version

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
equalsback to summary
public boolean equals(Object o)

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
o: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
getArtifactIdback to summary
public String getArtifactId()
getGroupIdback to summary
public String getGroupId()
getMajorVersionback to summary
public int getMajorVersion()
getMinorVersionback to summary
public int getMinorVersion()
getPatchLevelback to summary
public int getPatchLevel()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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
isSnapshotback to summary
public boolean isSnapshot()
isUknownVersionback to summary
public boolean isUknownVersion()

Deprecated

Since 2.7 use correctly spelled method isUnknownVersion()

Returns:boolean

True if this instance is the one returned by call to unknownVersion()

Annotations
@Deprecated
isUnknownVersionback to summary
public boolean isUnknownVersion()
Returns:boolean

True if this instance is the one returned by call to unknownVersion()

Since
2.7 to replace misspelled isUknownVersion()
toFullStringback to summary
public String toFullString()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
unknownVersionback to summary
public static Version unknownVersion()

Method returns canonical "not known" version, which is used as version in cases where actual version information is not known (instead of null).

Returns:Version

Version instance to use as a placeholder when actual version is not known (or not relevant)