Package xyz.rk0cc.josev.constraint

Class SemVerConstraint<E extends ConstraintPattern<? extends Enum<?>>>

java.lang.Object

xyz.rk0cc.josev.SemVerRange

xyz.rk0cc.josev.SemVerRange.NullableSemVerRange

xyz.rk0cc.josev.constraint.SemVerConstraint<E>

Type Parameters:

E - Definition of constraint pattern that available in the subclass.

All Implemented Interfaces:

Serializable, SemVerDetermineInRage

public abstract class SemVerConstraint<E extends ConstraintPattern<? extends Enum<?>>>
extends SemVerRange.NullableSemVerRange

Version constraint is a definition of SemVer range which bounding the version to ensure compatibility. This, class in extended from SemVerRange.NullableSemVerRange with more complicated detection to determine which SemVer can be accepted depending on different rules.

Since:

1.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class xyz.rk0cc.josev.SemVerRange

SemVerRange.NonnullSemVerRange, SemVerRange.NullableSemVerRange

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SemVerConstraint(E constraintPattern, String rawConstraint, SemVerRangeNode start, SemVerRangeNode end)	Create version constraint of SemVer.

Method Summary

Modifier and Type	Method	Description
final E	constraintPattern()	Detect which pattern is used for this constraint.
boolean	equals(Object o)
int	hashCode()
static <C extends SemVerConstraint<? extends ConstraintPattern<? extends Enum<?>>>> C	parse(Class<C> constraintClass, String versionConstraint)	Parser a String of versionConstraint and specify which Class that extended from SemVerConstraint will be exported.
final String	rawConstraint()	A String of constraint that came from parser.
String	toString()

Methods inherited from class xyz.rk0cc.josev.SemVerRange.NullableSemVerRange

end, isInRange, start

Methods inherited from class xyz.rk0cc.josev.SemVerRange

isInRange

Methods inherited from class java.lang.Object

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

Constructor Details

SemVerConstraint

protected SemVerConstraint(@Nonnull
 E constraintPattern,
 @Nullable
 String rawConstraint,
 @Nullable
 SemVerRangeNode start,
 @Nullable
 SemVerRangeNode end)

Create version constraint of SemVer.
All implemented subclass should keep this constructor as private scope.

Parameters:

constraintPattern - An ConstraintPattern that applied from parser.

rawConstraint - The version constraint that inserted by user.

start - Start of the version range.

end - End of the version range.

Method Details

constraintPattern

@Nonnull
public final E constraintPattern()

Detect which pattern is used for this constraint.

Returns:

An Enum which implemented ConstraintPattern that indicating the constraint syntax pattern used in this constraint.

rawConstraint

@Nullable
public final String rawConstraint()

A String of constraint that came from parser.

Returns:

User input value of the version constraint.

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

parse

public static <C extends SemVerConstraint<? extends ConstraintPattern<? extends Enum<?>>>>
C parse(@Nonnull
 Class<C> constraintClass,
 @Nullable
 String versionConstraint)

Parser a String of versionConstraint and specify which Class that extended from SemVerConstraint will be exported.
Not all Class which inherited from SemVerConstraint can be parsed by this method unless it meets these requirements:

• The class must be public, non-abstract class
• Do not implement any public scope constructor
• Has a static method that returns the same Class of constraintClass
• Annotated SemVerConstraintParser with proper configurations:
  • Set enabled as true
  • Proper name of the static method

If one of these requirement is missed, it will throw UnsupportedOperationException.

Type Parameters:

C - Defined which subclass of SemVerConstraint will be returned.

Parameters:

constraintClass - A well implemented Class which inherited from SemVerConstraint.

versionConstraint - A String of version constraint.

Returns:

An object of SemVerConstraint with corresponded data of SemVerConstraint.

Throws:

UnsupportedOperationException - If the implementation does not meet all requirement on the list.

See Also:

• SemVerConstraintParser