Package com.helger.diver.api.coord

Class DVRCoordinate

java.lang.Object

com.helger.diver.api.coord.DVRCoordinate

All Implemented Interfaces:

IDVRCoordinate, Comparable<DVRCoordinate>

@Immutable
@MustImplementComparable
@MustImplementEqualsAndHashcode
public final class DVRCoordinate
extends Object
implements IDVRCoordinate, Comparable<DVRCoordinate>

The DVR Coordinate represents the coordinate of a single technical artefact in a specific version.
It was originally called VESID for "Validation Executor Set ID" but is now used in a wider range of use cases. The name was changed for release v2 to DVRID. In v3 the name was changed again to DVR Coordinate.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final char	PART_SEPARATOR	The separator char between ID elements

Constructor Summary

Constructors

Constructor	Description
DVRCoordinate(String sGroupID, String sArtifactID, DVRVersion aVersion)	Constructor.
DVRCoordinate(String sGroupID, String sArtifactID, DVRVersion aVersion, String sClassifier)	Constructor.

Method Summary

Modifier and Type	Method	Description
static int	compare(DVRCoordinate aLeft, DVRCoordinate aRight)
int	compareTo(DVRCoordinate aOther)
static DVRCoordinate	create(String sGroupID, String sArtifactID, String sVersion)	Factory method without classifier.
static DVRCoordinate	create(String sGroupID, String sArtifactID, String sVersion, String sClassifier)	Factory method for DVR coordinates.
boolean	equals(Object o)
String	getArtifactID()
String	getAsSingleID()
static String	getAsSingleID(String sGroupID, String sArtifactID, String sVersion, String sClassifier)
String	getClassifier()
String	getGroupID()
DVRVersion	getVersionObj()
DVRCoordinate	getWithArtifactID(String sNewArtifactID)
DVRCoordinate	getWithClassifier(String sNewClassifier)
DVRCoordinate	getWithGroupID(String sNewGroupID)
DVRCoordinate	getWithVersion(DVRVersion aNewVersion)
DVRCoordinate	getWithVersion(IDVRPseudoVersion aPseudoVersion)
DVRCoordinate	getWithVersionLatest()
DVRCoordinate	getWithVersionLatestRelease()
int	hashCode()
static DVRCoordinate	parseOrNull(String sCoords)
static DVRCoordinate	parseOrThrow(String sCoords)	Try to parse the provided coordinates String.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.diver.api.coord.IDVRCoordinate

getVersionString, hasClassifier

Field Details

PART_SEPARATOR

public static final char PART_SEPARATOR

The separator char between ID elements

See Also:

• Constant Field Values

Constructor Details

DVRCoordinate

public DVRCoordinate(@Nonnull @Nonempty
 String sGroupID,
 @Nonnull @Nonempty
 String sArtifactID,
 @Nonnull
 DVRVersion aVersion)

Constructor. All parameters must match the constraints from DVRValidityHelper.isValidCoordinateGroupID(String), DVRValidityHelper.isValidCoordinateArtifactID(String) and DVRValidityHelper.isValidCoordinateVersion(String).

Parameters:

sGroupID - Group ID. May neither be null nor empty.

sArtifactID - Artifact ID. May neither be null nor empty.

aVersion - Version object. May not be null.

Since:

1.1.2

DVRCoordinate

public DVRCoordinate(@Nonnull @Nonempty
 String sGroupID,
 @Nonnull @Nonempty
 String sArtifactID,
 @Nonnull
 DVRVersion aVersion,
 @Nullable
 String sClassifier)

Constructor. All parameters must match the constraints from DVRValidityHelper.isValidCoordinateGroupID(String), DVRValidityHelper.isValidCoordinateArtifactID(String), DVRValidityHelper.isValidCoordinateVersion(String) and DVRValidityHelper.isValidCoordinateClassifier(String).

Parameters:

sGroupID - Group ID. May neither be null nor empty.

sArtifactID - Artifact ID. May neither be null nor empty.

aVersion - Version object. May not be null.

sClassifier - Classifier. May be null.

Method Details

getGroupID

@Nonnull
@Nonempty
public String getGroupID()

Specified by:

getGroupID in interface IDVRCoordinate

Returns:

The coordinate's group ID. May never be null nor empty.

getArtifactID

@Nonnull
@Nonempty
public String getArtifactID()

Specified by:

getArtifactID in interface IDVRCoordinate

Returns:

The coordinate's artifact ID. May never be null nor empty.

getVersionObj

@Nonnull
public DVRVersion getVersionObj()

Specified by:

getVersionObj in interface IDVRCoordinate

Returns:

The coordinates version object. Never null.

getClassifier

@Nullable
public String getClassifier()

Specified by:

getClassifier in interface IDVRCoordinate

Returns:

The coordinate's optional classifier ID. May be null or empty.

getWithGroupID

@Nonnull
public DVRCoordinate getWithGroupID(@Nullable
 String sNewGroupID)

getWithArtifactID

@Nonnull
public DVRCoordinate getWithArtifactID(@Nullable
 String sNewArtifactID)

getWithVersion

@Nonnull
public DVRCoordinate getWithVersion(@Nonnull
 DVRVersion aNewVersion)

getWithVersion

@Nonnull
public DVRCoordinate getWithVersion(@Nonnull
 IDVRPseudoVersion aPseudoVersion)

getWithVersionLatest

@Nonnull
public DVRCoordinate getWithVersionLatest()

getWithVersionLatestRelease

@Nonnull
public DVRCoordinate getWithVersionLatestRelease()

getWithClassifier

@Nonnull
public DVRCoordinate getWithClassifier(@Nullable
 String sNewClassifier)

getAsSingleID

@Nonnull
@Nonempty
public static String getAsSingleID(@Nonnull @Nonempty
 String sGroupID,
 @Nonnull @Nonempty
 String sArtifactID,
 @Nonnull @Nonempty
 String sVersion,
 @Nullable
 String sClassifier)

getAsSingleID

@Nonnull
@Nonempty
public String getAsSingleID()

Specified by:

getAsSingleID in interface IDVRCoordinate

Returns:

A joint String representation of the coordinates. The different parts are separated by a colon (:) character. Never null nor empty.

compare

public static int compare(@Nonnull
 DVRCoordinate aLeft,
 @Nonnull
 DVRCoordinate aRight)

compareTo

public int compareTo(@Nonnull
 DVRCoordinate aOther)

Specified by:

compareTo in interface Comparable<DVRCoordinate>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
public static DVRCoordinate create(@Nonnull @Nonempty
 String sGroupID,
 @Nonnull @Nonempty
 String sArtifactID,
 @Nonnull @Nonempty
 String sVersion)
                            throws DVRVersionException

Factory method without classifier. All parameters must match the constraints from DVRValidityHelper.isValidCoordinateGroupID(String), DVRValidityHelper.isValidCoordinateArtifactID(String) and DVRValidityHelper.isValidCoordinateVersion(String).

Parameters:

sGroupID - Group ID. May neither be null nor empty.

sArtifactID - Artifact ID. May neither be null nor empty.

sVersion - Version string. May neither be null nor empty.

Returns:

The created DVRCoordinate and never null.

Throws:

DVRVersionException - if the provided version is invalid

create

@Nonnull
public static DVRCoordinate create(@Nonnull @Nonempty
 String sGroupID,
 @Nonnull @Nonempty
 String sArtifactID,
 @Nonnull @Nonempty
 String sVersion,
 @Nullable
 String sClassifier)
                            throws DVRVersionException

Factory method for DVR coordinates. All parameters must match the constraints from DVRValidityHelper.isValidCoordinateGroupID(String), DVRValidityHelper.isValidCoordinateArtifactID(String), DVRValidityHelper.isValidCoordinateVersion(String) and DVRValidityHelper.isValidCoordinateClassifier(String).

Parameters:

sGroupID - Group ID. May neither be null nor empty.

sArtifactID - Artifact ID. May neither be null nor empty.

sVersion - Version string. May neither be null nor empty.

sClassifier - Classifier. May be null.

Returns:

The created DVRCoordinate and never null.

Throws:

DVRVersionException - if the provided version is invalid

parseOrThrow

@Nonnull
public static DVRCoordinate parseOrThrow(@Nullable
 String sCoords)
                                  throws DVRCoordinateException,
DVRVersionException

Try to parse the provided coordinates String. This is the reverse operation to getAsSingleID().

Parameters:

sCoords - The coordinate string to parse. May be null.

Returns:

Never null

Throws:

DVRCoordinateException - In case the layout is incorrect

DVRVersionException - In case the version is incorrect

parseOrNull

@Nullable
public static DVRCoordinate parseOrNull(@Nullable
 String sCoords)