Class SemanticVersion.PreReleaseIdentifier

java.lang.Object

xyz.apollosoftware.bibliothiki.versioning.schemes.semver.SemanticVersion.PreReleaseIdentifier

All Implemented Interfaces:

Comparable<SemanticVersion.PreReleaseIdentifier>

Enclosing class:

SemanticVersion

public static class SemanticVersion.PreReleaseIdentifier
extends Object
implements Comparable<SemanticVersion.PreReleaseIdentifier>

A pre-release build identifier.

Identifiers are parsed as numeric identifiers first and, if not numeric, validated as non-numeric identifiers using the regular expression provided by the Semantic Versioning (SemVer) specification.

See Also:

• parse(String)

Method Summary

Modifier and Type	Method	Description
int	compareTo(@NonNull SemanticVersion.PreReleaseIdentifier other)
boolean	equals(Object o)
int	hashCode()
boolean	isNumeric()	Whether the identifier was parsed as a numeric value.
@Nullable Integer	numericValue()	Get the numeric value, if there is one.
static @NonNull SemanticVersion.PreReleaseIdentifier	parse(@NonNull String value)	Parse the given value as a SemanticVersion.PreReleaseIdentifier.
static @NonNull SemanticVersion.PreReleaseIdentifier	preRelease(@NonNull String value)	A static sugar for parse(String).
@NonNull String	rawValue()	Get the raw string value for the identifier.
String	toString()

Methods inherited from class Object

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

Method Details

preRelease

public static @NonNull SemanticVersion.PreReleaseIdentifier preRelease(@NonNull String value)

A static sugar for parse(String).

Parameters:

value - The value to parse.

Returns:

The parsed SemanticVersion.PreReleaseIdentifier.

See Also:

• parse(String)

parse

public static @NonNull SemanticVersion.PreReleaseIdentifier parse(@NonNull String value)

Parse the given value as a SemanticVersion.PreReleaseIdentifier.

If the value is empty, it will be rejected upon construction as this is forbidden by the Semantic Versioning (SemVer) specification.

If the value is numeric, it is parsed as a numeric identifier. If the identifier starts with a leading zero, but would otherwise be numeric, a VersioningException is thrown.

If the value is not numeric, it is parsed as a non-numeric identifier and is then validated against the prescribed regular expression (from the specification) upon construction. If it is not valid, per the regular expression, a VersioningException is thrown.

Parameters:

value - The value to parse.

Returns:

The parsed SemanticVersion.PreReleaseIdentifier.

Throws:

VersioningException - If the identifier is not valid.

rawValue

public @NonNull String rawValue()

Get the raw string value for the identifier.

Returns:

The raw string value.

numericValue

public @Nullable Integer numericValue()

Get the numeric value, if there is one.

Returns:

The numeric value, or null if one is not set.

isNumeric

public boolean isNumeric()

Whether the identifier was parsed as a numeric value.

This is true when the numericValue() is not null.

Returns:

True if, and only if, the identifier has a numeric value.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(@NonNull SemanticVersion.PreReleaseIdentifier other)

Specified by:

compareTo in interface Comparable<SemanticVersion.PreReleaseIdentifier>