org.diet4j.core

Class ModuleRequirement

java.lang.Object

org.diet4j.core.ModuleRequirement

All Implemented Interfaces:

Serializable

public class ModuleRequirement
extends Object
implements Serializable

This collects all information needed to find a Module.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	MAVEN_VERSION_REGEX The regex defining Maven version expressions.
protected boolean	theIsOptional Is this dependency optional.
protected String	theMaxRequiredModuleVersion The maximum version of the required Module.
protected boolean	theMaxRequiredModuleVersionIsInclusive Is the maximum version inclusive.
protected String	theMinRequiredModuleVersion The minimum version of the required Module.
protected boolean	theMinRequiredModuleVersionIsInclusive Is the minimum version inclusive.
protected Object[][]	theParsedMaxRequiredModuleVersion Parsed form of the maximum version of the required Module.
protected Object[][]	theParsedMinRequiredModuleVersion Parsed form of the minimum version of the required Module.
protected String	theRequiredModuleArtifactId The artifactId of the required Module.
protected String	theRequiredModuleGroupId The groupId of the required Module.
protected String	theUninterpretedRequiredModuleVersion The uninterpreted version string of the ModuleRequirement.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModuleRequirement(String requiredModuleGroupId, String requiredModuleArtifactId, String requiredModuleVersion, boolean isOptional) Construct one.

Method Summary

Modifier and Type	Method and Description
protected int	compareParsedVersionParts(Object[] a, Object[] b) Helper method to compare version parts.
protected int	compareParsedVersions(Object[][] a, Object[][] b) Compare two parsed versions.
static ModuleRequirement	create(String requiredModuleArtifactId) Factory method.
static ModuleRequirement	create(String requiredModuleGroupId, String requiredModuleArtifactId) Factory method.
static ModuleRequirement	create(String requiredModuleGroupId, String requiredModuleArtifactId, String requiredModuleVersion) Factory method.
static ModuleRequirement	create(String requiredModuleGroupId, String requiredModuleArtifactId, String requiredModuleVersion, boolean isOptional) Factory method.
protected void	ensureVersionsParsed() Ensure that the min and max versions have been parsed.
ModuleMeta[]	findVersionMatchesFrom(ModuleMeta[] candidates) Given an ordered set of ModuleMetas, find the matching versions.
String	getRequiredModuleArtifactId() Obtain the artifactId of the Module that we require.
String	getRequiredModuleGroupId() Obtain the groupId of the Module that we require.
String	getUninterpretedRequiredModuleVersion() Obtain the version of the Module that we require.
boolean	isOptional() Determine whether this ModuleRequirement is optional.
boolean	matches(ModuleMeta candidate) Determine whether a candidate ModuleMeta meets this ModuleRequirement.
boolean	matchesVersionRequirement(String version) Determine whether the provided version String matches the version requirement in this ModuleRequirement.
static ModuleRequirement	parse(String s) Factory method using a String representation corresponding to toString().
protected void	parseAndSetMinMaxVersions(String s) Parse a version string, and set the properties on this instance accordingly.
protected Object[][]	parseVersion(String v) Take a version string and parse it into its components.
String	toString() Obtain a string representation of this object, for debugging purposes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

theRequiredModuleGroupId

protected String theRequiredModuleGroupId

The groupId of the required Module.

theRequiredModuleArtifactId

protected String theRequiredModuleArtifactId

The artifactId of the required Module.

theUninterpretedRequiredModuleVersion

protected String theUninterpretedRequiredModuleVersion

The uninterpreted version string of the ModuleRequirement.

theMinRequiredModuleVersion

protected String theMinRequiredModuleVersion

The minimum version of the required Module.

theMinRequiredModuleVersionIsInclusive

protected boolean theMinRequiredModuleVersionIsInclusive

Is the minimum version inclusive.

theParsedMinRequiredModuleVersion

protected Object[][] theParsedMinRequiredModuleVersion

Parsed form of the minimum version of the required Module. Calculated on demand.

theMaxRequiredModuleVersion

protected String theMaxRequiredModuleVersion

The maximum version of the required Module.

theMaxRequiredModuleVersionIsInclusive

protected boolean theMaxRequiredModuleVersionIsInclusive

Is the maximum version inclusive.

theParsedMaxRequiredModuleVersion

protected Object[][] theParsedMaxRequiredModuleVersion

Parsed form of the maximum version of the required Module. Calculated on demand.

theIsOptional

protected boolean theIsOptional

Is this dependency optional.

MAVEN_VERSION_REGEX

public static Pattern MAVEN_VERSION_REGEX

The regex defining Maven version expressions.

Constructor Detail

ModuleRequirement

protected ModuleRequirement(String requiredModuleGroupId,
                            String requiredModuleArtifactId,
                            String requiredModuleVersion,
                            boolean isOptional)

Construct one.

Parameters:

requiredModuleGroupId - the groupId of the required Module

requiredModuleArtifactId - the artifactId of the required Module

requiredModuleVersion - the version of the required Module, null if any

isOptional - if true, this ModuleRequirement is optional

Method Detail

create

public static ModuleRequirement create(String requiredModuleArtifactId)

Factory method.

Parameters:

requiredModuleArtifactId - the artifactId of the required Module

Returns:

the created ModuleRequirement

create

public static ModuleRequirement create(String requiredModuleGroupId,
                                       String requiredModuleArtifactId)

Factory method.

Parameters:

requiredModuleGroupId - the groupId of the required Module

requiredModuleArtifactId - the artifactId of the required Module

Returns:

the created ModuleRequirement

create

public static ModuleRequirement create(String requiredModuleGroupId,
                                       String requiredModuleArtifactId,
                                       String requiredModuleVersion)

Factory method.

Parameters:

requiredModuleGroupId - the groupId of the required Module

requiredModuleArtifactId - the artifactId of the required Module

requiredModuleVersion - the version of the required Module

Returns:

the created ModuleRequirement

create

public static ModuleRequirement create(String requiredModuleGroupId,
                                       String requiredModuleArtifactId,
                                       String requiredModuleVersion,
                                       boolean isOptional)

Factory method.

Parameters:

requiredModuleGroupId - the groupId of the required Module

requiredModuleArtifactId - the artifactId of the required Module

requiredModuleVersion - the version of the required Module, null if any

isOptional - if true, this ModuleRequirement is optional

Returns:

the created ModuleRequirement

parse

public static ModuleRequirement parse(String s)
                               throws ParseException

Factory method using a String representation corresponding to toString().

Parameters:

s - the String to be parsed

Returns:

the created ModuleRequirement

Throws:

ParseException - thrown if the provided s did have an invalid syntax

getRequiredModuleGroupId

public final String getRequiredModuleGroupId()

Obtain the groupId of the Module that we require.

Returns:

the groupId of the Module that we require

getRequiredModuleArtifactId

public final String getRequiredModuleArtifactId()

Obtain the artifactId of the Module that we require.

Returns:

the artifactId of the Module that we require

getUninterpretedRequiredModuleVersion

public final String getUninterpretedRequiredModuleVersion()

Obtain the version of the Module that we require. This returns the uninterpreted version string.

Returns:

the version of the Module that we require

isOptional

public final boolean isOptional()

Determine whether this ModuleRequirement is optional.

Returns:

true, if the ModuleRequirement is optional

matches

public boolean matches(ModuleMeta candidate)

Determine whether a candidate ModuleMeta meets this ModuleRequirement.

Parameters:

candidate - the candidate ModuleMeta

Returns:

true if the ModuleMeta matches this ModuleRequirement

findVersionMatchesFrom

public ModuleMeta[] findVersionMatchesFrom(ModuleMeta[] candidates)

Given an ordered set of ModuleMetas, find the matching versions.

Parameters:

candidates - the ModuleMeta candidates

Returns:

the matched ModuleMetas

matchesVersionRequirement

public boolean matchesVersionRequirement(String version)

Determine whether the provided version String matches the version requirement in this ModuleRequirement.

Parameters:

version - the version string

Returns:

true or false

compareParsedVersions

protected int compareParsedVersions(Object[][] a,
                                    Object[][] b)

Compare two parsed versions.

Parameters:

a - the first parsed version

b - the second parsed version

Returns:

-1, 0 or 1 like strcmp()

compareParsedVersionParts

protected int compareParsedVersionParts(Object[] a,
                                        Object[] b)

Helper method to compare version parts.

Parameters:

a - first version part

b - second version part

Returns:

-1, 0 or 1 like strcmp()

parseAndSetMinMaxVersions

protected void parseAndSetMinMaxVersions(String s)

Parse a version string, and set the properties on this instance accordingly.

Parameters:

s - the version string

ensureVersionsParsed

protected void ensureVersionsParsed()

Ensure that the min and max versions have been parsed.

parseVersion

protected Object[][] parseVersion(String v)

Take a version string and parse it into its components.

Parameters:

v - the version string

Returns:

the components, left to right

toString

public String toString()

Obtain a string representation of this object, for debugging purposes.

Overrides:

toString in class Object

Returns:

string representation of this object