org.azyva.dragom.model

Class ModuleVersion

java.lang.Object

org.azyva.dragom.model.ModuleVersion

public final class ModuleVersion
extends Object

Represents a specific Version of a Module. Includes a NodePath (which cannot not be partial) and a Version.

Implements value semantics. Instances are immutable.

Implements hashCode() and equals(java.lang.Object) so that instances can be used as Map keys.

ModuleVersion support the literal form <NodePath>:<Version> where <NodePath> is the NodePath in String format and <Version> is the Version in literal form.

Example: Acme/module:D/master

Author:

David Raymond

Constructor Summary

Constructors

Constructor and Description
ModuleVersion(NodePath nodePath) Constructor using only a NodePath, with a null Version.
ModuleVersion(NodePath nodePath, Version version) Constructor using the individual fields.
ModuleVersion(String stringModuleVersion) Constructor using a ModuleVersion literal.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
NodePath	getNodePath()
Version	getVersion() Returns the Version.
int	hashCode()
static ModuleVersion	parse(String stringModuleVersion) Parses a ModuleVersion literal.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleVersion

public ModuleVersion(NodePath nodePath,
                     Version version)

Constructor using the individual fields.

Parameters:

nodePath - NodePath. Cannot be partial.

version - Version. Can be null to represent the default Version of a Module, or simply not include a Version.

ModuleVersion

public ModuleVersion(NodePath nodePath)

Constructor using only a NodePath, with a null Version.

Such a ModuleVersion is incomplete. It can be used in WorkspaceDirUserModuleVersion and WorkspacePlugin.getSetWorkspaceDir(java.lang.Class<? extends org.azyva.dragom.execcontext.plugin.WorkspaceDir>) to get all workspace directories for a given Module.

Note that such a ModuleVersion is a special case and cannot be parsed from a literal.

Parameters:

nodePath - NodePath. Cannot be partial.

ModuleVersion

public ModuleVersion(String stringModuleVersion)

Constructor using a ModuleVersion literal.

Throws RuntimeException if parsing fails.

Parameters:

stringModuleVersion - ModuleVersion literal.

Method Detail

parse

public static ModuleVersion parse(String stringModuleVersion)
                           throws ParseException

Parses a ModuleVersion literal.

Parameters:

stringModuleVersion - Version literal.

Returns:

Version.

Throws:

ParseException - If parsing fails.

getNodePath

public NodePath getNodePath()

Returns:

NodePath.

getVersion

public Version getVersion()

Returns the Version.

Can be null in some cases to represent the default Version of a Module as defined by the ScmPlugin.

Returns:

See description.

toString

public String toString()

Overrides:

toString in class Object

Returns:

ModuleVersion literal.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object