org.azyva.dragom.execcontext.plugin

Class WorkspaceDirUserModuleVersion

java.lang.Object

org.azyva.dragom.execcontext.plugin.WorkspaceDirUserModuleVersion

All Implemented Interfaces:

WorkspaceDir

public class WorkspaceDirUserModuleVersion
extends Object
implements WorkspaceDir

Represents a user workspace directory that contains a ModuleVersion. During a checkout operation, for example, such directories are created for the user. Depending on the SCM from which the module comes from, that directory will generally also be a workspace for module managed by this SCM. For example, if the module comes from a Git repository, the directory will be a Git clone of the repository for the module, with the specified version checked out. This class does not include the plugin that created the workspace directory since it belongs to the user and any plugin can potentially interact with it one behalf of the user. However only one SCM plugin will generally interact with such a workspace directory since it is module specific and one SCM plugin is associated with a given module. This class wraps ModuleVersion which already provides the required information and behavior. But it must implement the marker interface WorkspaceDir, which is why ModuleVersion is not used directly.

Author:

David Raymond

Constructor Summary

Constructors

Constructor and Description
WorkspaceDirUserModuleVersion(ModuleVersion moduleVersion) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Override of equals to make to make instances of this class usable as map keys and in other contexts where value equality semantics are required.
ModuleVersion	getModuleVersion()
int	hashCode() Override of hashCode to make instances of this class usable efficiently as map keys.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceDirUserModuleVersion

public WorkspaceDirUserModuleVersion(ModuleVersion moduleVersion)

Constructor.

Parameters:

moduleVersion - ModuleVersion.

Method Detail

getModuleVersion

public ModuleVersion getModuleVersion()

Returns:

ModuleVersion.

toString

public String toString()

Overrides:

toString in class Object

Returns:

String to help recognize the WorkspaceDir instance, in logs for example.

hashCode

public int hashCode()

Override of hashCode to make instances of this class usable efficiently as map keys. This implementation was generated automatically using Eclipse and then simplified.

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Override of equals to make to make instances of this class usable as map keys and in other contexts where value equality semantics are required.

Overrides:

equals in class Object