Module iu.util.type.impl

Package iu.type

Class ComponentVersion

java.lang.Object

iu.type.ComponentVersion

All Implemented Interfaces:

IuComponentVersion, Comparable<IuComponentVersion>

class ComponentVersion
extends Object
implements IuComponentVersion

Implementation of IuComponentVersion.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final ComponentVersion	SERVLET_6	Specification version constant for detecting Jakarta Servlet version 6 or higher.

Fields inherited from interface edu.iu.type.IuComponentVersion

SEMANTIC_VERSION_PATTERN

Constructor Summary

Constructors

Constructor	Description
ComponentVersion(String name, int major, int minor)	Creates a specification version.
ComponentVersion(String name, String version)	Creates an implementation version
ComponentVersion(String extenstionListItem, Attributes mainAttributes)	Reads a dependency item from an extension list

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Two implementation versions are equal if both name and implementation version are equal.
int	hashCode()	Note that when using IuComponentVersion in a Set or as a key in a HashMap or Hashtable that is important to be aware whether of whether or not the members and/or keys are expected to represent a specification version.
String	implementationVersion()	Gets the implementation version of a component or dependency.
int	major()	Gets the major version number as defined by Semantic Versioning.
int	minor()	Gets the minor version number as defined by Semantic Versioning.
String	name()	Gets the component name.
(package private) static ComponentVersion	of(Path pathEntry)	Determines the component version for a path entry: class folder or jar file.
ComponentVersion	specificationVersion()	Gets the specification version implied by this version reference.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.iu.type.IuComponentVersion

compareTo, meets

Field Details

SERVLET_6

static final ComponentVersion SERVLET_6

Specification version constant for detecting Jakarta Servlet version 6 or higher.

Constructor Details

ComponentVersion

ComponentVersion(String name,
 int major,
 int minor)

Creates a specification version.

Parameters:

name - extension name

major - major version number

minor - minor version number

ComponentVersion

ComponentVersion(String name,
 String version)

Creates an implementation version

Parameters:

name - extension name

version - implementation version

ComponentVersion

ComponentVersion(String extenstionListItem,
 Attributes mainAttributes)

Reads a dependency item from an extension list

Parameters:

extenstionListItem - extension list item

mainAttributes - Manifest.getMainAttributes()

Method Details

of

static ComponentVersion of(Path pathEntry)
                    throws IOException

Determines the component version for a path entry: class folder or jar file.

Parameters:

pathEntry - path entry

Returns:

component version

Throws:

IOException - if an I/O error occurs discovering the component version

name

public String name()

Description copied from interface: IuComponentVersion

Gets the component name.

The component name should be universally unique, and must be unique within the component's path. The name is part of of the component's version.

Specified by:

name in interface IuComponentVersion

Returns:

name

implementationVersion

public String implementationVersion()

Description copied from interface: IuComponentVersion

Gets the implementation version of a component or dependency.

Must return a value for which IuComponentVersion.SEMANTIC_VERSION_PATTERN.matcher(implementationVersion()).matches() returns true, or null.

Specified by:

implementationVersion in interface IuComponentVersion

Returns:

Full Semantic implementation version of the component.
May be null when referring to a dependency on the component's specification version.
Must start with major() + '.' + minor() + '.' when non-null.

major

public int major()

Description copied from interface: IuComponentVersion

Gets the major version number as defined by Semantic Versioning.

Specified by:

major in interface IuComponentVersion

Returns:

Major version; must be non-negative, should be positive. Non-development applications may reject versions with a major version of 0.

minor

public int minor()

Description copied from interface: IuComponentVersion

Gets the minor version number as defined by Semantic Versioning.

Specified by:

minor in interface IuComponentVersion

Returns:

Minor version; must be non-negative

specificationVersion

public ComponentVersion specificationVersion()

Description copied from interface: IuComponentVersion

Gets the specification version implied by this version reference.

The specification version relates to the minor version of the implementation. For example, if the implementation version is 1.2.34-SNAPSHOT, then the specification version is 1.2.

Specified by:

specificationVersion in interface IuComponentVersion

Returns:

Specification version implied by this version reference. For an implementation version, the version of the implemented specification is returned. For a specification version, this is returned.

See Also:

• IuComponentVersion.major()
• IuComponentVersion.minor()

hashCode

public int hashCode()

Description copied from interface: IuComponentVersion

Note that when using IuComponentVersion in a Set or as a key in a HashMap or Hashtable that is important to be aware whether of whether or not the members and/or keys are expected to represent a specification version.

Specified by:

hashCode in interface IuComponentVersion

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Description copied from interface: IuComponentVersion

Two implementation versions are equal if both name and implementation version are equal. Two specification versions are equal if IuComponentVersion.name(), IuComponentVersion.major(), and IuComponentVersion.minor() are equal.

An implementation version is never equal to a specification version.

Note that versions are case-sensitive.

Specified by:

equals in interface IuComponentVersion

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object